接口功能介绍
弃用 1 份云主机私有镜像。
准备：
1. 在调用前需了解如何构造请求，可参见：如何调用 API - 构造请求。
2. OpenAPI 请求需进行加密调用，可参见：如何调用 API - 认证鉴权。
注意：在调用前，请您认真阅读此文档，包括但不限于参数描述中的“注意”部分。
接口约束
接口请求成功需至少满足：
1. 您具有调用此接口的权限。
2. 传入的 imageID 参数所指定的镜像满足要求。
3. 传入的 regionID 参数所指定的资源池满足要求。
URI
POST /v4/image/deactivate
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| imageID | 是 | String | 镜像 ID。可使用查询可以使用的镜像资源接口来查询您可使用的镜像资源，可使用查询镜像详细信息接口来查询 1 份镜像的详细信息，可使用查询私有镜像的共享列表接口来查询 1 份私有镜像的共享列表。注意：所指定的镜像应是私有镜像的共享数量为 0、镜像状态为 active、镜像类型不为 iso_image 的私有镜像。此镜像在非多可用区资源池中还应是镜像类型不为 full_ecs_image 的镜像。 | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
| regionID | 是 | String | 资源池 ID。可使用资源池列表查询接口来查询您可见的资源池的列表。注意：此接口仅支持具备弃用/取消弃用私有镜像的功能的资源池。 | 88f8888888dd88ec888888888d888d8b |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。取值范围（值：描述）： 800：成功。 900：失败。 |
800 | |
| error | String | 错误码（product.module.code 三段式码）。 | Openapi.PatternCheck.NotValid | |
| errorCode | String | 同 error 参数。 | Openapi.PatternCheck.NotValid | |
| message | String | 响应状态描述（一般为英文）。 | SUCCESS | |
| description | String | 响应状态描述（一般为中文）。 | 成功 | |
| returnObj | Object | 成功时返回的数据。 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例：若您在华东 1 有 1 份 ID 为 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa 的私有镜像，则可参考如下形式弃用私有镜像。
{
"imageID": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa",
"regionID": "bb9fdb42056f11eda1610242ac110002"
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"returnObj": {}
}
状态码
请参考 状态码
错误码
请参考 错误码
