请求地址:

请求地址请求方法
/api/snapshot/createPOST

请求参数

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

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

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

clientidString32代理客户端ID

异步返回示例

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

异步返回参数说明

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


同步返回示例

{
    "TaskID": "a6151e0c281dd3561cc4aaff21e236dc",
    "Describe": "创建虚拟机快照(ID:114)",
    "Content": {
        "task": {
            "event_name": "EVENT_VM_SNAPSHOT_ADD",
            "task_errcode": "200",
            "task_errmsg": "success"
        },
        "vm": {
            "vmid": "114"
        }
    },
    "InsertTime": 1695461188,
    "UpdateTime": 1695461189,
    "ExpireTime": 1695547588
}

同步返回参数说明

参数描述
TaskID任务ID
Describe任务描述
Clientid代理客户端ID
Content任务详情
    task任务执行信息
        event_name事件名称
        task_errcode错误代码
        task_errmsg错误提示
    vm虚拟机信息
        vmid虚拟机ID
        snapshotid快照ID
InsertTime任务创建时间
UpdateTime任务更新时间
ExpireTime任务有效时间



异常示例

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