接口功能介绍
创建快照
接口约束
无
URI
POST /v3/snapshot/create
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 |
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 快照名称，只能包含汉字、数字、英文字母、中划线和下划线，长度限制1-16个字符 | API_KZ | |
| desktopOid | 是 | String | 云电脑ID | D0023092701181644 | |
| resourcePackOid | 是 | String | 资源包ID | rsp-8qvf6t33j2yh97s3t8drc | |
| type | 是 | String | 快照类型，枚举值范围：[sys,data,all]（sys-系统盘;data-数据盘;all-系统盘和数据盘），其中data和all是数据盘相关的快照类型，请联系客户经理开通 | sys | |
| dataDiskOidList | 否 | Array of Strings | 数据盘ID列表，长度上限是5，type为data或all时必传 | null | |
| description | 是 | String | 描述，字符数限制[0,250] | API测试 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 |
800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | OK | |
| returnObj | Object | 返回数据结构体。 | returnObj |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{"name":"foo","desktopOid":"XXXXXXXXXXXXX6925","resourcePackOid":"rsp-foo","type":"sys","dataDiskOidList":null,"description":""}
响应示例
{"statusCode":800,"message":"OK.","returnObj":{ }}
状态码
请参考 状态码
错误码
请参考 错误码
