请求地址:

请求地址请求方法
/api/vm/diskinfoPOST

请求参数

参数类型是否必填最大长度描述示例值
vmidString32虚拟机ID
modeint1响应模式:0同步、1异步,默认为1,各差异如下:

同步:服务器不会立即响应客户端,一直等待超时或者任务已被执行(不管成功与失败)

异步:服务器会立即响应客户端,通过任务ID获得任务执行结果

clientidString32代理客户端ID

异步返回示例

{
    "errcode": "200",
    "errmsg": "ok",
    "data": {
        "vmid": "32",
        "taskid": "be1e6a4682502fb8ad89a12444c40998"
    }
}

异步返回参数说明

参数描述
vmid虚拟机ID
taskid任务ID,可用于获取任务执行信息


同步返回示例

{
    "TaskID": "694727bf7f3d93e814ecc8b26c35c0a7",
    "Describe": "虚拟机磁盘信息",
    "Content": {
        "task": {
            "event_name": "EVENT_VM_DISKINFO",
            "task_errcode": "200",
            "task_errmsg": "success"
        },
        "vm": {
            "disk_list": [
                {
                    "fileName": "[data_1t] user/win7-x64-39/win7-x64-39.vmdk",
                    "key": "2000",
                    "label": "Hard disk 1",
                    "summary": "50 GB",
                    "unitNumber": "0",
                    "uuid": "6000C299-960c-7834-098f-6033191d3aa2"
                },
                {
                    "fileName": "[data_1t] vmdk/4.vmdk",
                    "key": "2002",
                    "label": "Hard disk 2",
                    "summary": "10 MB",
                    "unitNumber": "2",
                    "uuid": "6000C294-f110-9a5e-efcd-7224ba7b72d8"
                },
                {
                    "fileName": "[data_1t] vmdk/3.vmdk",
                    "key": "2015",
                    "label": "Hard disk 3",
                    "summary": "130 MB",
                    "unitNumber": "15",
                    "uuid": "6000C292-cd0a-c4ce-c74f-7cc37cf69ab7"
                }
            ],
            "vmid": "143"
        }
    },
    "InsertTime": 1695652200,
    "UpdateTime": 1695652201,
    "ExpireTime": 1695738600
}

同步返回参数说明

参数描述
TaskID任务ID
Describe任务描述
Clientid代理客户端ID
Content任务详情
    task任务执行信息
        event_name事件名称
        task_errcode错误代码
        task_errmsg错误提示
    vm虚拟机信息
        vmid虚拟机ID
        disk_list

磁盘列表

            uuid

磁盘唯一ID

            label

磁盘标签

            summary

磁盘容量

            controllerKey

磁盘SCSI 控制器ID

            scsiNumber

磁盘SCSI 控制器编号

            unitNumber

磁盘SCSI 控制器单元号

            fileName

磁盘文件

InsertTime任务创建时间
UpdateTime任务更新时间
ExpireTime任务有效时间



异常示例

{"errcode":"500","errmsg":"内部错误"}