DescribeDrdsDBs - 查看实例下的数据库列表 - 云原生数据库 PolarDB

调用DescribeDrdsDBs接口查看实例下的数据库详情。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
DrdsInstanceId	string	是	实例 ID。	drdshbga1138****
PageNumber	integer	否	页码，取值为大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。	1
PageSize	integer	否	每页记录数，取值为 30、50 或 100。默认值为 30。	30
RegionId	string	是	地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
PageSize	string	每页记录数。	30
PageNumber	string	页码。	1
RequestId	string	请求 ID。	006B7D19-8CDB-4AA6-AAE7-23C107GS3W2T
Total	string	数据库列表的总数量。	1
Success	boolean	请求是否成功。	true
Data	array<object>	数据库列表。
Db	object
Status	string	数据库状态。	NORMAL
DbName	string	数据库名称。	drds_test
Schema	string	系统为拆分后的数据库分配的 schema ID。	drds_test_1563773871118kxqd
CreateTime	string	数据库创建时间，格式为 Unix 时间戳，单位为毫秒。	1563773824000
Mode	string	数据库拆分模式，取值范围如下： HORIZONTAL：水平拆分 VERTICAL：垂直拆分	HORIZONTAL
DbInstType	string	数据库类型，取值为 RDS 或 POLARDB。	RDS

示例

正常返回示例

JSON格式

{
  "PageSize": 30,
  "PageNumber": 1,
  "RequestId": "006B7D19-8CDB-4AA6-AAE7-23C107GS3W2T",
  "Total": 1,
  "Success": true,
  "Data": {
    "Db": [
      {
        "Status": "NORMAL",
        "DbName": "drds_test",
        "Schema": "drds_test_1563773871118kxqd",
        "CreateTime": 1563773824000,
        "Mode": "HORIZONTAL",
        "DbInstType": "RDS"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	ActionUnauthorized	The specified action is not available for you	指定的action未授权，请您先做RAM授权再进行操作。
404	InvalidDRDSInstanceId.NotFound	The DrdsInstanceId provided does not exist in our records.	-
500	InternalError	The request processing has failed due to some unknown error.	请求失败，内部错误

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

变更历史

变更时间	变更内容概要	操作
2023-04-07	OpenAPI 错误码发生变更	查看变更详情