DescribeDrdsDbInstances - 查询数据库 RDS 列表 - 云原生数据库 PolarDB

查询 DRDS 数据库下面的 RDS 列表。

接口说明

查询 DRDS 数据库下面的 RDS 主实例列表，每个 RDS 主实例的 ReadOnlyInstances 属性是该 RDS 在当前数据库中使用的 RDS 只读实例列表

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
drds:DescribeDrdsDbInstances	get	*instance `acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}`	无	无

请求参数

名称	类型	必填	描述	示例值
DrdsInstanceId	string	是	实例 ID。	drdshbga1138****
DbName	string	是	数据库名称。	dbname
PageNumber	integer	否	页码。	1
PageSize	integer	否	每页数量。	30

返回参数

名称	类型	描述	示例值
	object
PageSize	string	每页大小。	10
PageNumber	string	页码。	1
RequestId	string	请求 ID。	2F7F8080-9132-4279-85D0-B7E5C4305162
Total	string	RDS 主实例总数。	1
Success	boolean	请求是否成功。	true
DbInstances	array<object>	数据库下的存储实例列表。
DbInstance	object
ExpireTime	string	存储实例过期时间。	1237486127634
PayType	string	付费类型。	PostPaid
DBInstanceStatus	string	0：创建中 1：运行中 3：删除中 5：重启中 6：升降级中 7：备份中 8：内外网切换中 9：迁移中 11：迁移数据中 12：生成灾备实例中 13：数据导入中 14：从其他 RDS 实例导入数据中 15：容灾切换中 16：创建临时实例中 17：网络创建中 18：实例克隆中 19：链路切换中 20：只读实例迁移中	1
NetworkType	string	网络类型。	VPC
Port	integer	端口。	3306
EngineVersion	string	存储引擎版本，比如 RDS for MySQL 的 5.7、5.6、5.5。	5.7
DmInstanceId	string	资源 ID。	dm-hbgau1zp****
ConnectUrl	string	存储实例的链接地址，调用对应存储（比如 RDS）接口返回的链接地址。	rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com
ReadWeight	integer	在数据库中的读写权重。	30
RdsInstType	string	是 RDS 主实例还是只读实例。	Primary
RemainDays	integer	预付费实例剩余过期天数。	0
DBInstanceId	string	存储实例 ID。	rm-bp1t1mk5a5bdj****
DbInstType	string	存储实例类型，仅支持 RDS。	RDS
Engine	string	存储引擎，比如 RDS 的 MySQL。	MySQL
ReadOnlyInstances	array<object>	存储实例的只读实例列表。
ReadOnlyInstance	object
ExpireTime	string	存储实例过期时间戳。	123421352351234
PayType	string	付费类型。	Postpaid
DBInstanceStatus	string	存储实例状态。	1
NetworkType	string	实例网络类型。	VPC
Port	integer	实例访问端口。	3306
EngineVersion	string	存储实例引擎版本。	5.7
DmInstanceId	string	资源 ID。	dm-hbgau1zp****
ConnectUrl	string	存储实例的链接地址，调用对应存储（比如 RDS）接口返回的链接地址。	rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com
ReadWeight	integer	实例读写比例。	70
RdsInstType	string	实例类型。	RDS
InstanceName	string	保留字段。	**
RemainDays	integer	实例过期剩余天数。	0
DbInstType	string	存储实例类型。	RDS
Engine	string	存储实例引擎。	MySQL

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "2F7F8080-9132-4279-85D0-B7E5C4305162",
  "Total": 1,
  "Success": true,
  "DbInstances": {
    "DbInstance": [
      {
        "ExpireTime": 1237486127634,
        "PayType": "PostPaid",
        "DBInstanceStatus": 1,
        "NetworkType": "VPC",
        "Port": 3306,
        "EngineVersion": 5.7,
        "DmInstanceId": "dm-hbgau1zp****",
        "ConnectUrl": "rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com",
        "ReadWeight": 30,
        "RdsInstType": "Primary",
        "RemainDays": 0,
        "DBInstanceId": "rm-bp1t1mk5a5bdj****",
        "DbInstType": "RDS",
        "Engine": "MySQL",
        "ReadOnlyInstances": {
          "ReadOnlyInstance": [
            {
              "ExpireTime": 123421352351234,
              "PayType": "Postpaid",
              "DBInstanceStatus": 1,
              "NetworkType": "VPC",
              "Port": 3306,
              "EngineVersion": 5.7,
              "DmInstanceId": "dm-hbgau1zp****",
              "ConnectUrl": "rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com",
              "ReadWeight": 70,
              "RdsInstType": "RDS",
              "InstanceName": "**",
              "RemainDays": 0,
              "DbInstType": "RDS",
              "Engine": "MySQL"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	The request processing has failed due to some unknown error.	请求失败，内部错误

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史