接口功能介绍
调用接口查询资源池信息(regionId 创建实例接口需要的参数)。
接口约束
无
URI
GET /v1/open-api/instance/region
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
accountId | 是 | String | 用户id | testaccount001 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码 | 0 | |
message | 是 | String | 返回消息 | ||
returnObj | 是 | Array of Objects | 返回结果信息 | returnObj |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池Id | d15ff6c8f92011e4a2fbe2ad47403cea | |
regionName | 是 | String | 资源池名称 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": [
{
"regionId": "d15ff6c8f92011e4a2fbe2ad47403cea",
"regionName": "北京"
},
{
"regionId": "577604052f1611e7af8ac68bf8eb941a",
"regionName": "福州"
}
]
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |