查询创建逻辑库可选取的数据节点实例列表V3
功能介绍
查询创建逻辑库可选取的数据节点实例列表
URI
GET /v3/{project_id}/instances/{instance_id}/available-data-nodes
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 租户在某一region下的project ID。 获取方法请参见获取项目ID。 |
| instance_id | 是 | String | DDM实例ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0。 取值必须为数字，且不能为负数。 |
| limit | 否 | Integer | 查询个数上限值。 取值范围：1~128。 不传该参数时，默认值为10。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data_nodes | Array of AvailableDnInstance objects | 可用后端DN信息。 |
| offset | Integer | 分页参数：起始值。 |
| limit | Integer | 分页参数：每页多少条。 |
| total | Integer | 总数。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | DN实例ID。 |
| status | String | DN实例状态。 |
| name | String | DN实例名称。 |
| engine_name | String | DN实例引擎名称。 |
| engine_version | String | DN实例引擎版本。 |
| private_ip | String | DN实例私有IP。 |
| port | Integer | DN实例端口。 |
| time_zone | String | DN实例时区。 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误消息。 |
状态码：500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误消息。 |
请求示例
GET https://{endpoint}/v3/{project_id}/instances/{instance_id}/available-data-nodes?offset=0&limit=10 响应示例
状态码：200
{
"data_nodes": [
{
"id": "085ef55*****d1c9770fa92413a8822in01",
"status": "normal",
"name": "rds-f2f2",
"engine_name": "mysql",
"engine_version": "8.0",
"private_ip": "127.0.0.1",
"port": 3306,
"time_zone": "UTC+08:00"
}
],
"offset": 0,
"limit": 10,
"total": 1
} 状态码：400
bad request
{
"error_msg" : "Parameter error.",
"error_code" : "DBS.280001"
} 状态码：500
server error
{
"error_msg" : "Parameter error.",
"error_code" : "DBS.280001"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | ok |
| 400 | bad request |
| 500 | server error |
错误码
请参见错误码。
