接口功能介绍
查询使用镜像文件来创建私有镜像的任务列表。
准备:
1. 在调用前需了解如何构造请求,可参见:如何调用 API - 构造请求。
2. OpenAPI 请求需进行加密调用,可参见:如何调用 API - 认证鉴权。
注意:
1. 此接口已弃用,目前仍可调用。若您欲查询镜像状态为 queued 等的私有镜像,则可使用查询可以使用的镜像资源接口来查询您可使用的镜像资源,可使用查询镜像详细信息接口来查询 1 份镜像的详细信息。
2. 在调用前,请您认真阅读此文档,包括但不限于参数描述中的“注意”部分。
接口约束
接口请求成功需至少满足:
1. 您具有调用此接口的权限。
2. 传入的有取值范围的参数的值在取值范围内。
3. 传入的 regionID 参数所指定的资源池对您而言是存在的。
URI
GET /v4/image/list-import-tasks
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池 ID。可使用资源池列表查询接口来查询您可见的资源池的列表。 | 88f8888888dd88ec888888888d888d8b | |
pageNo | 否 | Integer | 页码。取值范围:最小 1(默认值)。 | 1 | |
pageSize | 否 | Integer | 每页记录数目。取值范围:最小 1,最大 50,默认 10。 | 10 |
请求参数
请求头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 | 成功时返回的数据。 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
imageImportTasks | Array of Strings | 创建私有镜像(镜像文件)任务列表。 | [] | |
currentPage | Integer | 当前页码。 | 1 | |
currentCount | Integer | 当前页记录数。 | 10 | |
totalPage | Integer | 总页数。 | 1 | |
totalCount | Integer | 总记录数。 | 10 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例 1:查询您在华东 1 创建私有镜像(镜像文件)的第 1 页(每页最多 10 份镜像)任务列表。
GET .../v4/image/list-import-tasks?regionID=bb9fdb42056f11eda1610242ac110002
示例 2:查询您在华东 1 创建私有镜像(镜像文件)的第 2 页(每页最多 20 份镜像)任务列表。
GET .../v4/image/list-import-tasks?pageNo=2&pageSize=20®ionID=bb9fdb42056f11eda1610242ac110002
响应示例
{
"returnObj": {
"imageImportTasks": [],
"currentPage": 1,
"currentCount": 0,
"totalPage": 1,
"totalCount": 0
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码