接口功能介绍
弃用一份私有镜像。
接口约束
接口请求成功需至少满足：
1. 所指定的私有镜像的状态应是 active。可使用查询镜像详细信息接口来查询一份镜像的详细信息。
2. 所指定的私有镜像的共享列表中没有共享镜像。可使用查询私有镜像的共享列表接口来查询一份私有镜像的共享列表。
URI
POST /v4/image/deactivate
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| imageID | 是 | String | 镜像 ID。可使用查询可以使用的镜像资源接口来查询您可使用的镜像资源。 | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
| regionID | 是 | String | 资源池 ID。可使用资源池列表查询接口来查询您可见的资源池的列表。 | 88f8888888dd88ec888888888d888d8b |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码，取值范围（值：描述）： 800：成功 900：失败 |
800 | |
| error | String | 错误码（product.module.code 三段式码）。 | ||
| errorCode | String | 同“error”参数。 | ||
| message | String | 响应状态描述（一般为英文）。 | ||
| description | String | 响应状态描述（一般为中文）。 | ||
| returnObj | Object | 返回参数。 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"imageID": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa",
"regionID": "88f8888888dd88ec888888888d888d8b"
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"returnObj": {}
}
状态码
请参考 状态码
错误码
请参考 错误码
