全部产品
Search
文档中心

云原生数据库 PolarDB:DescribeDrdsDB - 查看实例下的数据库详情

更新时间:Jul 10, 2026

调用DescribeDrdsDB接口查询实例下的数据库详情。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DrdsInstanceIdstring

实例 ID。

drds*********
DbNamestring

数据库名称。

db_test

返回参数

名称类型描述示例值
object
Successboolean

请求结果。

true
RequestIdstring

请求 ID。

58FB0EC7-CF71-4E48-92FB-CF070D******
Dataobject

数据库详情。

Statusstring

数据库状态,取值范围如下:

  • TO_BE_INIT:创建中
  • NORMAL:运行中
NORMAL
DbNamestring

数据库名称。

db_test
Schemastring

数据库物理名。

db_test*******************
CreateTimestring

数据库创建的时间点,格式为 Unix 时间戳,单位为毫秒(ms)。

1602050276000
Modestring

数据库拆分方式,取值范围如下:

  • HORIZONTAL:水平拆分
  • VERTICAL:垂直拆分
HORIZONTAL
DbInstTypestring

数据库的存储类型。

RDS
InstRolestring

数据库所属的实例类型,取值范围如下:

  • MASTER:主实例
  • SLAVE:只读实例
MASTER

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "58FB0EC7-CF71-4E48-92FB-CF070D******",
  "Data": {
    "Status": "NORMAL",
    "DbName": "db_test",
    "Schema": "db_test*******************",
    "CreateTime": 1602050276000,
    "Mode": "HORIZONTAL",
    "DbInstType": "RDS",
    "InstRole": "MASTER"
  }
}

错误码

HTTP status code错误码错误信息
404InvalidDbName.NotFoundThe Drds DbName provided does not exist in our records.

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

变更历史

变更时间变更内容概要操作
暂无变更历史