查询创建逻辑库可选取的数据库实例列表
功能介绍
查询创建逻辑库可选取的数据库实例列表。
接口约束
无。
URI
GET /v1/{project_id}/instances/{instance_id}/rds | 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 租户在某一region下的project ID。 |
| instance_id | 是 | String | DDM实例ID。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| instances | Array of instances objects | 可用数据库实例相关信息的集合。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 可用数据库实例id。 |
| projectId | String | 租户在某一region下的project ID。 |
| status | String | 可用数据库实例当前状态。 |
| name | String | 可用数据库实例名称。 |
| engineName | String | 可用数据库实例引擎名称。 |
| engineSoftwareVersion | String | 可用数据库实例引擎版本。 |
| privateIp | String | 可用数据库实例私有ip。 |
| mode | String | 可用数据库实例的模式，集群或单例。 |
| port | Integer | 可用数据库实例的端口。 |
| azCode | String | 可用区编码。 |
| timeZone | String | 时区。 |
状态码： 400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| errCode | String | 业务错误码。 |
| externalMessage | String | 错误信息.。 |
状态码： 500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| errCode | String | 业务错误码. |
| externalMessage | String | 错误信息。 |
请求示例
GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/rds 响应示例
状态码： 200
OK
{
"instances": [
{
"id": "a44a103e64634a2e872d1ab2523bb838in01",
"projectId": "070c071d8e80d58c2f42c0121b10cf9f",
"status": "normal",
"name": "rds-ab04-test",
"engineName": "mysql",
"engineSoftwareVersion": "8.0",
"privateIp": "192.168.0.72",
"mode": "Single",
"port": 3306,
"azCode": "az1xahz",
"timeZone": "UTC+08:00"
}
]
} 状态码： 400
bad request
{
"externalMessage" : "Parameter error.",
"errCode" : "DBS.280001"
} 状态码： 500
server error
{
"externalMessage" : "Parameter error.",
"errCode" : "DBS.280001"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | bad request |
| 500 | server error |
错误码
请参见错误码。
