# 查询远程数据库列表 - ListRemoteDb #### 功能介绍 订阅远程实例时，查询远程SQLServer的数据库列表。 - 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。 - 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=ListRemoteDb)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:instance:update | write | - | - | rds:instance:modify | - | #### URI - URI格式 POST /v3/{project_id}/instances/{instance_id}/replication/remote-databases - 参数说明 表1参数说明 | 名称 | 是否必选 | 说明 | |:---|:---|:---| | project_id | 是 | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 非空。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_id | 是 | **参数解释：** 实例ID。 **约束限制：** 非空。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | server_ip | 是 | String | **参数解释：** 远程数据库IP。 **约束限制：** 不涉及。 **取值范围：** 必须为IP格式。 **默认取值：** 不涉及。 | | server_port | 是 | String | **参数解释：** 远程数据库端口。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | login_user_name | 是 | String | **参数解释：** 远程数据库用户。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | login_user_password | 是 | String | **参数解释：** 远程数据库用户密码。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | offset | 否 | int | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制：** 不涉及。 **取值范围：** 大于等于0的整数。 **默认取值：** 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | | limit | 否 | int | **参数解释：** 查询记录数。 **约束限制：** 不涉及。 **取值范围：** \[1, 100\] **默认取值：** 10 | #### 请求示例 查询远程数据库列表。 ``` POST https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/72ee4cc4607347049df9ad50f615bbd8in04/replication/remote-databases { "server_ip": "192.168.0.1", "server_port": "1433", "login_user_name": "user1", "login_user_password": "pass1" } ``` #### 响应消息 - 正常响应要素说明 表3要素说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | databases | Array of objects | **参数解释：** 列表中每个元素表示一个数据库。 详情请参见[表4]。 | | total_count | Integer | **参数解释：** 数据库列表总数。 **取值范围：** 不涉及。 | 表4databases要素说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | name | String | **参数解释：** 数据库名称。 **取值范围：** 不涉及。 | | character_set | String | **参数解释：** 数据库使用的字符集。 **取值范围：** SQL Server支持的字符集列表，请参见[表2](https://support.huaweicloud.com/api-rds/rds_05_0010.html#rds_05_0010__table17474517)。 取值示例：Chinese_PRC_CI_AS。 | | state | String | **参数解释：** 数据库状态。 **取值范围：** - Creating：表示创建中。 - Running：表示使用中。 - Deleting：表示删除中。 - NotExists：表示不存在。 | - 正常响应样例 ``` { "databases": [ { "name": "master", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "msdb", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "model", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "tempdb", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "rdsadmin", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "rds-test", "character_set": "Chinese_PRC_CI_AS", "state": "Running" } ], "total_count": 6 } ``` - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。 #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。