9.Облачный диск
1. Постраничный список облачных дисков
Адрес интерфейса: /v1/cloud/drive/mgr/page/list
Метод запроса:POST
Тип данных запроса:application/json
Тип данных ответа:*/*,application/json
Поддерживаемая версия:v2.2.0
Описание интерфейса:
Постраничный список облачных дисков
Параметры запроса:
| Имя параметра | Описание параметра | Местоположение | Обязательно ли | Тип данных | Описание |
|---|---|---|---|---|---|
| projectId | Id проекта | body | false | string | По умолчанию проект по умолчанию текущего пользователя |
| nodeUuid | uuid узла | body | true | string | |
| status | Список статусов | body | false | list | 0:используется, 1:создается, 2:ошибка создания, 3:ожидает монтирования, 4:монтируется, 5:размонтируется, 6:расширяется, 7:сжимается, 8:удаляется, 9:ошибка удаления, 11:ошибка |
| names | Список имен облачных дисков | body | false | list | |
| uuids | список uuid облачных дисков | body | false | list | |
| resUuids | Список uuid ресурсов монтирования | body | false | list | |
| pageNum | Номер текущей страницы | body | false | integer | По умолчанию 1 |
| pageSize | Количество данных на текущей странице | body | false | integer | По умолчанию 10 |
Пример запроса, в фактическом запросе замените значения параметров:
POST "/openapi/v1/cloud/drive/mgr/page/list"
body:
{
"nodeUuid": "fb31044d1031d559a7b7268f36b65a6c",
"projectId": "7b5a664173f526309e43faf775f09d1d",
"resUuids": [],
"status": [3],
"uuids": []
}
Параметры ответа:
| Имя параметра | Описание параметра | Тип | Описание |
|---|---|---|---|
| code | Код возврата | integer(int32) | |
| message | Возвращаемое сообщение обработки | string | |
| result | Возвращаемый объект данных | IPage<Информация о регионе> | |
| records | Список данных текущей страницы | list<object> | |
| uuid | uuid | string | |
| name | Имя облачного диска | string | |
| type | Тип | integer | 1:SSD |
| mountPath | Путь монтирования | string | |
| resUuid | uuid монтируемой платы | string | |
| mountType | Тип цели монтирования | integer | 2.Голая плата 3:контейнер |
| storage | Емкость (единица: G) | integer | |
| projectId | Id проекта | string | |
| status | Статус | integer | 0:используется, 1:создается, 2:ошибка создания, 3:ожидает монтирования, 4:монтируется, 5:размонтируется, 6:расширяется, 7:сжимается, 8:удаляется, 9:ошибка удаления, 11:ошибка |
| remark | Примечание | string | |
| createTime | Время создания | string | |
| total | Общее количество записей | integer | |
| current | Номер текущей страницы | integer | |
| pages | Общее количество страниц | integer | |
| size | Количество строк на странице | integer | |
| timestamp | Временная метка | integer(int64) | |
| traceId | ID обработки запроса | boolean |
Пример ответа:
{
"message": "操作成功",
"code": 200,
"result": {
"records": [
{
"createTime": "2025-05-13 19:05:46",
"name": "mi182-2",
"remark": "mi182",
"storage": 8,
"type": 1,
"mountType": null,
"mountPath": null,
"resUuid": null,
"uuid": "042490b7600b4ee9a1f84a14d1cfe872",
"projectId": "7b5a664173f526309e43faf775f09d1d",
"status": 3
},
{
"createTime": "2025-05-13 19:05:46",
"name": "mi182-1",
"remark": "mi182",
"storage": 8,
"type": 1,
"mountType": 2,
"mountPath": null,
"resUuid": null,
"uuid": "a6e3e2248ca24f7b9fb2ad89820ba0e2",
"projectId": "7b5a664173f526309e43faf775f09d1d",
"status": 3
}
],
"total": 2,
"current": 1,
"pages": 1,
"size": 10
},
"timestamp": 1747135914033,
"traceId": "E20250513193154033052"
}
2. Создать облачный диск
Адрес интерфейса: /v1/cloud/drive/mgr/create
Метод запроса:POST
Тип данных запроса:application/json
Тип данных ответа:*/*,application/json
Поддерживаемая версия:v2.2.0
Описание интерфейса:
Создать облачный диск
Параметры запроса:
| Имя параметра | Описание параметра | Местоположение | Обязательно ли | Тип данных | Описание |
|---|---|---|---|---|---|
| projectId | Id проекта | body | false | string | По умолчанию проект по умолчанию текущего пользователя |
| nodeUuid | uuid узла | body | true | string | |
| name | Название | body | true | string | |
| type | Тип | body | true | integer | 1:SSD |
| storage | Емкость | body | true | integer | |
| number | Количество | body | true | integer | |
| remark | Примечание | body | false | string | |
| callbackUrl | Адрес callback уведомления | body | false | string | POST-запрос |
Пример запроса, в фактическом запросе замените значения параметров:
POST "/openapi/v1/cloud/drive/mgr/create"
body:
{
"nodeUuid":"fb31044d1031d559a7b7268f36b65a6c",
"projectId":"7b5a664173f526309e43faf775f09d1d",
"name":"mi182",
"type":1,
"storage":8,
"number":1,
"remark":"",
"callbackUrl":""
}
Параметры ответа:
| Имя параметра | Описание параметра | Тип | Описание |
|---|---|---|---|
| code | Код возврата | integer | |
| message | Возвращаемое сообщение обработки | string | |
| result | Возвращаемый объект данных | object | |
| jobs | Результат задачи | list<object> | |
| jobId | ID задачи | string | |
| code | Код статуса отправки задачи | integer | СоответствуетТаблица кодов статуса ответа |
| message | Описание отправки задачи | string | |
| uuid | uuid облачного диска | string | |
| projectId | Id проекта | string | |
| timestamp | Временная метка | integer | |
| traceId | ID обработки запроса | string |
Пример ответа:
{
"message": "操作成功",
"code": 200,
"result": {
"jobs": [
{
"jobId": "90a7954af9014eeba21036244c2729a3",
"code": 200,
"message": "success",
"uuid": "a6e3e2248ca24f7b9fb2ad89820ba0e2",
"projectId": "7b5a664173f526309e43faf775f09d1d"
}
]
},
"timestamp": 1747134346344,
"traceId": "E20250513190546314350"
}
3. Удалить облачный диск
Адрес интерфейса: /v1/cloud/drive/mgr/delete
Метод запроса:POST
Тип данных запроса:application/json
Тип данных ответа:*/*,application/json
Поддерживаемая версия:v2.2.0
Описание интерфейса:
Удалить облачный диск
Состояния, доступные для удаления, включают 2:ошибка создания, 3:ожидает монтирования, 9:ошибка удаления
Параметры запроса:
| Имя параметра | Описание параметра | Местоположение | Обязательно ли | Тип данных | Описание |
|---|---|---|---|---|---|
| nodeUuid | uuid узла | body | true | string | |
| uuids | список uuid облачных дисков | body | true | list | |
| projectId | Id проекта | body | false | string | По умолчанию проект по умолчанию текущего пользователя |
| callbackUrl | Адрес callback уведомления | body | false | string | POST-запрос |
Пример запроса, в фактическом запросе замените значения параметров:
POST "/openapi/v1/cloud/drive/mgr/delete"
body:
{
"nodeUuid":"fb31044d1031d559a7b7268f36b65a6c",
"uuids":["ed8f0fe711a249f69123745615aaa5bd"],
"projectId":"7b5a664173f526309e43faf775f09d1d"
}
Параметры ответа:
| Имя параметра | Описание параметра | Тип | Описание |
|---|---|---|---|
| code | Код возврата | integer | |
| message | Возвращаемое сообщение обработки | string | |
| result | Возвращаемый объект данных | object | |
| jobs | Результат задачи | list<object> | |
| jobId | ID задачи | string | |
| code | Код статуса отправки задачи | integer | СоответствуетТаблица кодов статуса ответа |
| message | Описание отправки задачи | string | |
| uuid | uuid облачного диска | string | |
| projectId | Id проекта | string | |
| timestamp | Временная метка | integer | |
| traceId | ID обработки запроса | string |
Пример ответа:
{
"message": "操作成功",
"code": 200,
"result": {
"jobs": [
{
"jobId": "a158c440b37840afbd26976151ff771c",
"code": 200,
"message": "success",
"uuid": "5a2065cef44c458fb4942c588e2d4622",
"projectId": "7b5a664173f526309e43faf775f09d1d"
}
]
},
"timestamp": 1747137063895,
"traceId": "E20250513195103748091"
}
4. Смонтировать облачный диск
Адрес интерфейса: /v1/cloud/drive/mgr/mount
Метод запроса:POST
Тип данных запроса:application/json
Тип данных ответа:*/*,application/json
Поддерживаемая версия:v2.2.0
Описание интерфейса:
Смонтировать облачный диск
Один облачный диск может быть смонтирован только на одно устройство; на одном устройстве в разные каталоги можно смонтировать несколько облачных дисков; в подкаталог каталога, где на том же устройстве уже смонтирован облачный диск, монтирование не допускается
Параметры запроса:
| Имя параметра | Описание параметра | Местоположение | Обязательно ли | Тип данных | Описание |
|---|---|---|---|---|---|
| nodeUuid | uuid узла | body | true | string | |
| list | Список монтирований | body | true | list | |
| resourceUuid | uuid ресурса | true | string | uuid платы или uuid контейнера | |
| cloudDriveUuid | uuid облачного диска | true | string | ||
| mountPath | Абсолютный путь каталога монтирования | false | string | При выборе типа контейнера не нужно передавать поле каталога монтирования, по умолчанию монтируется корневой каталог контейнера | |
| mountType | Тип ресурса монтирования | true | string | Тип ресурса монтирования. 2: голая плата; 3:контейнер | |
| instanceStart | Запущен ли контейнер | false | boolean | По умолчанию:да(то есть запуск) | |
| callbackUrl | Адрес callback уведомления | body | false | string | POST-запрос |
Пример запроса, в фактическом запросе замените значения параметров:
POST "/openapi/v1/cloud/drive/mgr/mount"
body:
{
"nodeUuid":"fb31044d1031d559a7b7268f36b65a6c",
"list":[
{
"resourceUuid":"cade41c164b2e87848a365d7fa3e118d",
"cloudDriveUuid":"3e25ec2f7103483b8abc8e3cde49ebca",
"mountPath":"/data/mount/mi802"
}
]
}
Параметры ответа:
| Имя параметра | Описание параметра | Тип | Описание |
|---|---|---|---|
| code | Код возврата | integer | |
| message | Возвращаемое сообщение обработки | string | |
| result | Возвращаемый объект данных | object | |
| jobs | Результат задачи | list<object> | |
| jobId | ID задачи | string | |
| code | Код статуса отправки задачи | integer | СоответствуетТаблица кодов статуса ответа |
| message | Описание отправки задачи | string | |
| uuid | uuid ресурса | string | |
| projectId | Id проекта | string | |
| timestamp | Временная метка | integer | |
| traceId | ID обработки запроса | string |
Пример ответа:
{
"message": "操作成功",
"code": 200,
"result": {
"jobs": [
{
"jobId": "d9a3bcbc36e54b0fb0e7f9260bcf816a",
"code": 200,
"message": "success",
"uuid": "cade41c164b2e87848a365d7fa3e118d",
"projectId": "7b5a664173f526309e43faf775f09d1d"
}
]
},
"timestamp": 1747104430892,
"traceId": "E20250513104710862038"
}
5. Отмонтировать облачный диск
Адрес интерфейса: /v1/cloud/drive/mgr/unmount
Метод запроса:POST
Тип данных запроса:application/json
Тип данных ответа:*/*,application/json
Поддерживаемая версия:v2.2.0
Описание интерфейса:
Отмонтировать облачный диск
Состояния, доступные для отмонтирования, включают 0:используется
Параметры запроса:
| Имя параметра | Описание параметра | Местоположение | Обязательно ли | Тип данных | Описание |
|---|---|---|---|---|---|
| nodeUuid | uuid узла | body | true | string | |
| list | Список удаления | body | true | list | |
| resourceUuid | uuid ресурса | true | string | uuid платы или uuid контейнера | |
| cloudDriveUuid | uuid облачного диска | true | string | ||
| mountType | Тип ресурса монтирования | true | string | Тип ресурса монтирования. 2: голая плата; 3:контейнер | |
| callbackUrl | Адрес callback уведомления | body | false | string | POST-запрос |
Пример запроса, в фактическом запросе замените значения параметров:
POST "/openapi/v1/cloud/drive/mgr/unmount"
body:
{
"nodeUuid":"fb31044d1031d559a7b7268f36b65a6c",
"list":[
{
"resourceUuid":"cade41c164b2e87848a365d7fa3e118d",
"cloudDriveUuid":"3e25ec2f7103483b8abc8e3cde49ebca"
}
]
}
Параметры ответа:
| Имя параметра | Описание параметра | Тип | Описание |
|---|---|---|---|
| code | Код возврата | integer | |
| message | Возвращаемое сообщение обработки | string | |
| result | Возвращаемый объект данных | object | |
| jobs | Результат задачи | list<object> | |
| jobId | ID задачи | string | |
| code | Код статуса отправки задачи | integer | СоответствуетТаблица кодов статуса ответа |
| message | Описание отправки задачи | string | |
| uuid | uuid ресурса | string | |
| projectId | Id проекта | string | |
| timestamp | Временная метка | integer | |
| traceId | ID обработки запроса | string |
Пример ответа:
{
"message": "操作成功",
"code": 200,
"result": {
"jobs": [
{
"jobId": "d9a3bcbc36e54b0fb0e7f9260bcf816a",
"code": 200,
"message": "success",
"uuid": "cade41c164b2e87848a365d7fa3e118d",
"projectId": "7b5a664173f526309e43faf775f09d1d"
}
]
},
"timestamp": 1747104430892,
"traceId": "E20250513104710862038"
}