文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 发布订阅（SQL Server）/ 查询线下数据库列表- GetReplicationRemoteDatabases
更新时间：2025-12-02 GMT+08:00
查看PDF
分享

查询线下数据库列表 - GetReplicationRemoteDatabases

功能介绍

订阅线下实例时，查询线下SQLServer的数据库列表。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

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。

    约束限制：

    非空。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    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条数据，表示从第一条数据开始查询）。

limit

否

int

参数解释：

查询记录数。

约束限制：

不涉及。

取值范围：

1~100

默认取值：

10

请求示例

查询线下数据库列表。 
PUT https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/72ee4cc4607347049df9ad50f615bbd8in04/replication/remote-databases

{
      "server_ip": "xx.x.x.x",
      "server_port": "1433",
      "login_user_name": "user1",
      "login_user_password": "passs1",
}

响应消息

  • 正常响应要素说明
    表3 要素说明

    名称

    参数类型

    说明

    databases

    Array of objects

    参数解释：

    列表中每个元素表示一个数据库。

    详情请参见表4。

    total_count

    Integer

    参数解释：

    数据库列表总数。

    取值范围：

    不涉及。
    表4 databases要素说明

    名称

    参数类型

    说明

    name

    String

    参数解释：

    数据库名称。

    取值范围：

    不涉及。

    character_set

    String

    参数解释：

    数据库使用的字符集。

    取值范围：

    SQL Server支持的字符集列表，请参见表2。

    取值示例：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
}

状态码

错误码

请参见错误码。

相关文档