# 查询订阅服务器实例列表 - ListSubscriberInstances
#### 功能介绍
查询可配置为当前实例订阅服务器的实例列表。
- 调用接口前，您需要了解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=ListSubscriberInstances)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项                     | 访问级别    | 资源类型（\*为必须） | 条件键 | 别名                  | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| rds:instance:update | write | -          | - | rds:instance:modify | -       |
   
#### URI
- URI格式 GET /v3/{project_id}/instances/{instance_id}/replication/subscribers?offset={offset}\&limit={limit}\&subscriber_instance_id={subscriber_instance_id}\&subscriber_instance_name={subscriber_instance_name}
  

- 参数说明
  表1参数说明 
  | 名称                             | 是否必选     | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
  |:---|:---|:---|
  | project_id                     | 是       | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 非空。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
  | instance_id              | 是 | **参数解释：** 实例ID。 **约束限制：** 非空。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                                                            |
  | offset                   | 否  | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制：** 不涉及。 **取值范围：** 大于等于0的整数。 **默认取值：** 默认为0（偏移0条数据，表示从第一条数据开始查询）。                                                                                                                                  |
  | limit                       | 否   | **参数解释：** 查询记录数。 **约束限制：** 不涉及。 **取值范围：** \[1, 100\] **默认取值：** 默认为10。                                                                                                                                                   |
  | subscriber_instance_id      | 否 | **参数解释：** 订阅服务器实例ID。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                                                       |
  | subscriber_instance_name | 否   | **参数解释：** 订阅服务器实例名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                                                              |
     
  
 
#### 请求消息
- 请求参数 无。
  
- URI样例 GET https://rds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/72ee4cc4607347049df9ad50f615bbd8in04/replication/subscribers?offset=0\&limit=10\&subscriber_instance_id=2ed347084f6b4faab16f6f2446f59d71in04\&subscriber_instance_name=testdb1
  
 
#### 响应消息
- 正常响应要素说明
  表2要素说明 
  | 名称                | 参数类型                  | 说明                                                                                                                                                                                                                  |
  |:---|:---|:---|
  | instances        | Array of objects | **参数解释：** 实例列表。 详情请参见[表3]。 |
  | total_count | Integer          | **参数解释：** 实例总数。 **取值范围：** 不涉及。                        |
     
   表3instances元素结构说明 
  | 名称            | 参数类型   | 说明                                                                                                                                                                                           |
  |:---|:---|:---|
  | instance_id         | String     | **参数解释：** 实例ID。 **取值范围：** 不涉及。  |
  | instance_name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。 |
  | data_vip                            | String                      | **参数解释：** 内网地址。 **取值范围：** 不涉及。            |
     
  

- 正常响应样例
  ```
  {
      "instances": [
          {
              "instance_id": "07c3f2976ce04a5cb60ffbcea3d293eain04",
              "instance_name": "rds-2ca1",
              "data_vip": "192.168.75.149"
          },
          {
              "instance_id": "75d98769cd5c4e8f8c20b4dd5b276bd2in04",
              "instance_name": "rds-4433-3",
              "data_vip": "192.168.106.206"
          }
      ],
      "total_count": 2
  }
  ```
  
- 异常响应 请参见[异常响应结果](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)。