接口介绍
查询可用资源池或者指定资源池对应的Endpoint信息。
接口约束
无
请求URI
GET /v1/radosGatewayConf/region
路径参数
无
Query参数
| 字段 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionCode | 否 | String | 区域编码，不传该参数或值为空会返回所有可用资源池的Endpoint信息 | 00001 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 本次请求的结果码 | 0 | |
| error | 是 | String | 错误码，查询成功时，不返回该字段 | ||
| message | 是 | String | 错误文本信息，查询成功时，为空字符串 | ||
| returnObj | 是 | String of Object | 返回结果 | returnObj |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | String | 业务返回码，0表示业务成功 | 0 | |
| data | 是 | Array of Objects | 业务返回数据 | data | |
| message | 是 | String | 业务消息 |
表 data
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionName | 是 | String | 区域名称 | 广东资源池1区 | |
| internetEndpoint | 是 | String | 地域对应的外网Endpoint | nmlj2oss.ctyun.store | |
| internalEndpoint | 否 | String | 地域对应的内网Endpoint | nmtcoss.ctyun.store |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": "0",
"message": "",
"returnObj": {
"code": "0",
"data": [
{
"regionName": "广东资源池1区",
"internetEndpoint": "nmlj2oss.ctyun.store",
"internalEndpoint": "nmtcoss.ctyun.store"
}
],
"message": ""
}
}
状态码
| 状态码 | 错误码 | 描述 |
|---|---|---|
| 0 | 表示业务成功 | |
| 400 | InvalidArgument | 请求参数有误 |
| 403 | AccessDenied | 用户鉴权失败，用户无操作权限 |
| 404 | 请求的资源不存在，输入错误的URL | |
| 500 | 业务执行异常 |
