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	通知回调地址	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	通知回调地址	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	通知回调地址	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	通知回调地址	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"
}