接口功能介绍
- 请将云电脑中的敏感数据删除之后再创建自定义镜像，避免数据安全隐患。- 请勿在创建镜像过程中对所选云电脑及其相关资源进行其他操作。- 目前只支持仅有1个数据盘的非池化云电脑进行创建整机镜像。- 创建整机镜像将会根据系统盘和数据盘的容量进行存储包资源扣减。
接口约束
无
URI
POST /v3/customImage/create
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 |
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| imageName | 是 | String | 镜像名称。只能由数字、英文字母、中划线、下划线和小数点组成，字符数限制[1,50]。 | Windows-Server-2019-Standard-v1.3 | |
| description | 否 | String | 描述。字符数限制[0,200]。默认为空字符串。 | fooDesc | |
| desktopOid | 是 | String | 云电脑ID | D0023092201180710 | |
| resourcePackOid | 是 | String | 资源包ID | rsp-t4o453t1hs44mr3fqfrj4 | |
| type | 否 | String | 镜像类型。默认值为：sys。取值范围：（sys-系统镜像;all-整机镜像） | null |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 |
800 | |
| error | String | 错误码。 | ECPC_1006 | |
| message | String | 提示信息。 | OK | |
| returnObj | Object | 返回数据结构体。 | returnObj |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{"imageName":"fooName","description":"fooDesc","desktopOid":"DXX","resourcePackOid":"rsp-xxx","type":null}
响应示例
{"statusCode":800,"message":"OK.","returnObj":{ }}
状态码
请参考 状态码
错误码
请参考 错误码
