接口功能介绍
查询所指定的源资源池的私有镜像支持复制到的目标资源池。
准备:
1. 在调用前需了解如何构造请求,可参见:如何调用 API - 构造请求。
2. OpenAPI 请求需进行加密调用,可参见:如何调用 API - 认证鉴权。
注意:在调用前,请您认真阅读此文档,包括但不限于参数描述中的“注意”部分。
接口约束
接口请求成功需至少满足:
1. 您具有调用此接口的权限。
2. 传入的 regionID 参数所指定的源资源池满足要求。
URI
GET /v4/image/list-supported-dest-crr-regions
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
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 | 成功时返回的数据。 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
regions | Array of Strings | 目标资源池 ID 列表。 | ["bb8fdb88888f88eda8888888ac888888"] |
枚举参数
无
请求示例
请求url
示例:查询华东 1 的私有镜像支持复制到的目标资源池。
GET .../v4/image/list-supported-dest-crr-regions?regionID=bb9fdb42056f11eda1610242ac110002
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"regions": [
"bb8fdb88888f88eda8888888ac888888"
]
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码