请求地址：

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

请求参数

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

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

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

clientidString是32代理客户端ID

异步返回示例

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

异步返回参数说明

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


同步返回示例

{
    "TaskID": "889b5897f6eb8e66735fe34a36299bc3",
    "Describe": "虚拟机全部快照(ID:114)",
    "Content": {
        "task": {
            "event_name": "EVENT_VM_SNAPSHOT_LIST",
            "task_errcode": "200",
            "task_errmsg": "success"
        },
        "vm": {
            "snapshot_list": [
                {
                    "Snapshot_Created_On": "9/23/2023 8:47:16",
                    "Snapshot_Desciption": "描述1",
                    "Snapshot_Id": "1",
                    "Snapshot_Name": "快照1",
                    "Snapshot_State": "powered off"
                }
            ],
            "vmid": "114"
        }
    },
    "InsertTime": 1695472957,
    "UpdateTime": 1695472957,
    "ExpireTime": 1695559357
}

同步返回参数说明

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

虚拟机快照列表

            Snapshot_Id快照ID
            Snapshot_Name快照名称
            Snapshot_Desciption快照描述
            Snapshot_Created_On快照创建时间
            Snapshot_State快照状态
InsertTime任务创建时间
UpdateTime任务更新时间
ExpireTime任务有效时间



异常示例

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