- 最新动态
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
- 用户指南
- API参考
- SDK参考
- 最佳实践
- 性能白皮书
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
查询创建逻辑库可选取的数据库实例列表
功能介绍
查询创建逻辑库可选取的数据库实例列表。
接口约束
无
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/instances/{instance_id}/rds?offset={offset}&limit={limit}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户在某一region下的project ID。 获取方法请参见获取项目ID。 |
|
instance_id |
是 |
String |
DDM实例ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0。 取值必须为数字，且不能为负数。 |
|
limit |
否 |
Integer |
查询个数上限值。 取值范围：1~128。 不传该参数时，默认值为128。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务的“获取用户Token”接口来获取。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
instances |
Array of QueryAvailableRdsList objects |
获取创建逻辑库可用数据库实例信息列表的集合。 |
|
offset |
Integer |
分页参数: 起始值。 |
|
limit |
Integer |
分页参数：每页多少条。 |
|
total |
Integer |
集合总数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
数据库实例 ID。 |
|
projectId |
String |
数据库实例所在租户在某一region下的project ID。 |
|
status |
String |
数据库实例状态。 |
|
name |
String |
数据库实例名称。 |
|
engineName |
String |
数据库实例引擎名称。 |
|
engineSoftwareVersion |
String |
数据库实例引擎版本。 |
|
privateIp |
String |
数据库实例内网连接地址。 |
|
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?offset={offset}&limit={limit}响应示例
状态码： 200
OK
{
"instances" : [ {
"id" : "c6f68fed9e74478c8679479a07d7d568in01",
"projectId" : "055d9f4ee780d4d42f96c01c1bc3c50c",
"status" : "normal",
"name" : "test-ddm-no-delete-test01-00",
"engineName" : "mysql",
"engineSoftwareVersion" : 5.7,
"privateIp" : "192.168.23.97",
"mode" : "Ha",
"port" : 3306,
"azCode" : "az1xahzaz1xahz",
"timeZone" : "UTC+08: 00"
}, {
"id" : "337e2598c2a64cb5935079f85996731din01",
"projectId" : "055d9f4ee780d4d42f96c01c1bc3c50c",
"status" : "normal",
"name" : "test-ddm-no-delete-test01",
"engineName" : "mysql",
"engineSoftwareVersion" : 5.7,
"privateIp" : "192.168.23.221",
"mode" : "Ha",
"port" : 3306,
"azCode" : "az1xahzaz1xahz",
"timeZone" : "UTC+08: 00"
} ],
"offset" : 0,
"limit" : 6,
"total" : 2
}状态码： 400
bad request
{
"externalMessage" : "Parameter error.",
"errCode" : "DBS.280001"
}状态码： 500
server error
{
"externalMessage" : "Server failure.",
"errCode" : "DBS.200412"
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
bad request |
|
500 |
server error |
错误码
请参见错误码。
