接口功能介绍
删除 1 个失败的使用镜像文件来创建私有镜像的任务。
准备:
1. 在调用前需了解如何构造请求,可参见:如何调用 API - 构造请求。
2. OpenAPI 请求需进行加密调用,可参见:如何调用 API - 认证鉴权。
注意:
1. 此接口在多可用区资源池已弃用,目前仍可调用。若您欲删除在多可用区资源池中使用镜像文件创建的、镜像状态为 error 的私有镜像,则可使用删除私有镜像接口来删除 1 份私有镜像。
2. 在调用前,请您认真阅读此文档,包括但不限于参数描述中的“注意”部分。
接口约束
接口请求成功需至少满足:
1. 您具有调用此接口的权限。
2. 传入的 regionID 参数所指定的资源池对您而言是存在的。
3. 传入的 taskID 参数所指定的任务满足要求。
URI
POST /v4/image/delete-import-task
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池 ID。可使用资源池列表查询接口来查询您可见的资源池的列表。 | 88f8888888dd88ec888888888d888d8b | |
taskID | 是 | String | 任务 ID。在非多可用区资源池中,可通过镜像详细信息中的 taskID 参数获取任务 ID。可使用查询可以使用的镜像资源接口来查询您可使用的镜像资源,可使用查询镜像详细信息接口来查询 1 份镜像的详细信息。注意:您需自行确保所指定的任务对您而言是存在的,且对应的镜像是镜像状态为 error 的私有镜像。否则,即使接口请求成功,任务也不会被删除。 | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa |
请求参数
请求头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
示例:若您在内蒙 6 有 1 份镜像状态为 error、任务 ID 为 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa 的私有镜像,则可参考如下形式删除此失败的使用镜像文件来创建私有镜像的任务。
{
"regionID": "6019b5007a0b11eab5db0242ac110002",
"taskID": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa"
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"returnObj": {}
}
状态码
请参考 状态码
错误码
请参考 错误码