全部产品
Search
文档中心

云数据库 RDS:DescribeDatabases - 查看实例下的数据库信息

更新时间:Mar 13, 2024

该接口用于查询RDS实例下的数据库信息。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeDatabasesRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
DBNamestring

数据库名称。

testDB01
DBStatusstring

数据库状态,取值:

  • Creating:创建中
  • Running:使用中
  • Deleting:删除中
Creating
PageSizeinteger

每页记录数,取值:

  • 30
  • 50
  • 100

默认值:30。

30
PageNumberinteger

页码,取值:大于 0 且不超过 Integer 的最大值。

默认值:1

1
ResourceGroupIdstring

资源组 ID。

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

2603CA96-B17D-4903-BC04-61A2C829CD94
Databasesobject []

数据库信息列表。

DBDescriptionstring

数据库描述。

testdb
DBStatusstring

数据库状态,返回值:

  • Creating:创建中
  • Running:使用中
  • Deleting:删除中
Creating
DBNamestring

数据库名称。

testDB01
DBInstanceIdstring

数据库所属实例 ID。

rm-uf6wjk5****
Enginestring

数据库实例类型。

MySQL
CharacterSetNamestring

字符集名称。

utf8
Collatestring

排序规则,此处 C 代表本土化。

说明 仅 PostgreSQL 实例返回该参数。
C
Ctypestring

字符集类型。

说明 仅 PostgreSQL 实例返回该参数。
en_US.utf8
ConnLimitstring

限制并发量,-1 代表未限制。

说明 仅 PostgreSQL 实例返回该参数。
-1
Tablespacestring

数据库表空间。

说明 仅 PostgreSQL 实例返回该参数。
pg_default
ResourceGroupIdstring

资源组 ID。

rg-acfmy****
Accountsobject []

拥有数据库相关权限的账号列表。

Accountstring

账号名称。

test
AccountPrivilegestring

账号对该数据库拥有的权限,返回值:

  • ReadWrite:读写
  • ReadOnly:只读
  • DMLOnly:仅 DML
  • DDLOnly:仅 DDL
DMLOnly
AccountPrivilegeDetailstring

账号对该数据库具有的权限。

SELECT
PageNumberinteger

每页记录数。

1
PageSizeinteger

页码。

30
TotalCountinteger

总记录数。

说明 仅 SQL Server 实例返回该参数。
5
BasicInfoobject []

数据库基础属性。

说明 仅 SQL Server 实例返回该参数。
object

数据库基础属性详情。

{ "allowedValues": [ "CHECKSUM" ], "databasePropertyName": "page_verify", "allowModify": true, "excludeLock": "0", "currentValue": "CHECKSUM" }
RuntimeInfoobject []

数据库运行属性。

说明 仅 SQL Server 实例返回该参数。
object

数据库运行属性详情。

{ "allowedValues": [], "databasePropertyName": "TotalDataSizeInMB", "allowModify": false, "currentValue": "5.38" }
AdvancedInfoobject []

数据库高级属性。

说明 仅 SQL Server 实例返回该参数。
object

数据库高级属性详情。

{ "allowedValues": [ "OFF", "ON" ], "databasePropertyName": "ansi_nulls", "allowModify": true, "excludeLock": "0", "currentValue": "OFF" }

示例

正常返回示例

JSON格式

{
  "RequestId": "2603CA96-B17D-4903-BC04-61A2C829CD94",
  "Databases": {
    "Database": [
      {
        "DBDescription": "testdb",
        "DBStatus": "Creating",
        "DBName": "testDB01",
        "DBInstanceId": "rm-uf6wjk5****",
        "Engine": "MySQL",
        "CharacterSetName": "utf8",
        "Collate": "C",
        "Ctype": "en_US.utf8",
        "ConnLimit": "-1",
        "Tablespace": "pg_default",
        "ResourceGroupId": "rg-acfmy****",
        "Accounts": {
          "AccountPrivilegeInfo": [
            {
              "Account": "test",
              "AccountPrivilege": "DMLOnly",
              "AccountPrivilegeDetail": "SELECT"
            }
          ]
        },
        "PageNumber": 1,
        "PageSize": 30,
        "TotalCount": 5,
        "BasicInfo": {
          "BasicDbProperty": [
            {
              "allowedValues": [
                "CHECKSUM"
              ],
              "databasePropertyName": "page_verify",
              "allowModify": true,
              "excludeLock": "0",
              "currentValue": "CHECKSUM"
            }
          ]
        },
        "RuntimeInfo": {
          "RuntimeDbProperty": [
            {
              "allowedValues": [],
              "databasePropertyName": "TotalDataSizeInMB",
              "allowModify": false,
              "currentValue": "5.38"
            }
          ]
        },
        "AdvancedInfo": {
          "AdvancedDbProperty": [
            {
              "allowedValues": [
                "OFF",
                "ON"
              ],
              "databasePropertyName": "ansi_nulls",
              "allowModify": true,
              "excludeLock": "0",
              "currentValue": "OFF"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Database.ConnectErrorDatabase connect error. please check instance status and database processlist数据库连接异常,请检查实例状态及数据库的连接池
400InvalidDBInstanceStatus.NotSupportThe Specified instance status is not supported to query account list.-
400Database.QueryErrorQuery Db failed, please check input value and instance status.查询数据库失败,请检查输入参数及实例状态。
400SqlExcutionFailedDatabase is in transition. Try the statement later.数据库正在变更,请稍后再试。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。

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

变更历史

变更时间变更内容概要操作
2023-08-09OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-06-21OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-03-24OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-01-06OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2022-09-15OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2022-09-15OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更