请求地址:

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

请求参数

参数类型是否必填最大长度描述示例值
vmidString64虚拟机ID
modeInt1

响应模式:0同步、1异步,默认为1,各差异如下:

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

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

1
clientidString32代理客户端ID

异步返回示例

{
    "errcode": "200",
    "errmsg": "ok",
    "data": {
        "taskid": "05df033533f8a7e49139aed1115bb009",
        "vmid": "104"
    }
}

异步返回参数说明

参数描述
vmid虚拟机ID
taskid任务ID,可用于获取任务执行信息,详情参数参考以下同步返回参数说明


同步返回示例

{
    "TaskID":"ee25787e8b2059cf6dd478a1c0b00983",
    "Describe":"虚拟机可用SCSI控制器单元号(ID:147)",
    "Content":{
        "client":{
            "id":"76803510cea5fbbfeeeb86d608d381fa"
        },
        "task":{
            "event_name":"EVENT_VM_CONTROLLER_UNIT_NUMBER",
            "task_errcode":"200",
            "task_errmsg":"success"
        },
        "vm":{
            "scsi_unit":[
                0,
                2
            ],
            "vmid":"147"
        }
    },
    "InsertTime":1699691718,
    "UpdateTime":1699691724,
    "ExpireTime":1699778118
}

同步返回参数说明

参数描述
TaskID任务ID
Describe任务描述
Clientid代理客户端ID
Content任务详情
    task任务执行信息
        event_name事件名称
        task_errcode错误代码
        task_errmsg错误提示
    vm虚拟机信息
        vmid虚拟机ID
        scsi_unit当前占用SCSI控制器单元号列表
InsertTime任务创建时间
UpdateTime任务更新时间
ExpireTime任务有效时间


异常示例

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