全部产品
Search

搜索本产品

    云原生数据仓库AnalyticDB：DescribeDatabase - 描述数据库

    文档中心

    云原生数据仓库AnalyticDB：DescribeDatabase - 描述数据库

    更新时间：Jan 15, 2026

    描述一个adbpg数据库的基本信息。

    调试

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

    授权信息

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

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

    请求参数

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

    实例 ID。

    说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 版实例的详情，包括实例 ID。
    		gp-xxxxxxxxx
    DatabaseNamestring是

    数据库名称。

    		test01

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    请求 ID。

    		ABB39CC3-4488-4857-905D-2E4A051D0521
    DBInstanceIdstring

    实例 ID。

    		gp-xxxxxxxxx
    DatabaseNamestring

    数据库名称。

    • 只能包含字母，数字和下划线。

    • 必须以字母开头。

    • 长度不能超过 63 个字符。

    		test01
    Descriptionstring

    数据库备注。

    		A user management database storing customer profiles.
    CharacterSetNamestring

    字符集。

    取值范围可以参考文档 https://www.postgresql.org/docs/current/multibyte.html

    		UTF8
    Collatestring

    数据库区域设置参数，指定字符串比较/排序规则。

    说明
  • 语言环境必须与 CharacterSetName 参数设置的字符集兼容。
  • Collate 取值：可通过 SELECT DISTINCT collname FROM pg_collation; 命令查询获取，不配置时默认为 en_US.utf8。
    •
    		en_US.utf8
    Ctypestring

    数据库区域设置参数，指定字符分类/大小写转换规则。

    说明
  • 语言环境必须与 CharacterSetName 参数设置的字符集兼容。
  • 可通过 SELECT DISTINCT collctype FROM pg_collation; 命令查询获取，不配置时默认为 en_US.utf8。
    •
    		en_US.utf8
    ConnLimitstring

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

    		-1
    TableSpacestring

    数据库表空间。

    		pg_default
    Sizestring

    数据库大小。

    		2000 MB
    AccessPrivilegestring

    权限控制信息。

    		=Tc/test_001\ntest_001=CTc/test_001
    Ownerstring

    表的拥有者。

    • 由小写字母，数字，下划线组成。

    • 以小写字母开头，小写字母或数字结尾。

    • 不能以 gp 开头。

    • 长度为 2~16 个字符。

    		testadb

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "DBInstanceId": "gp-xxxxxxxxx",
  "DatabaseName": "test01",
  "Description": "A user management database storing customer profiles.",
  "CharacterSetName": "UTF8",
  "Collate": "en_US.utf8",
  "Ctype": "en_US.utf8",
  "ConnLimit": -1,
  "TableSpace": "pg_default",
  "Size": "2000 MB",
  "AccessPrivilege": "=Tc/test_001\\ntest_001=CTc/test_001",
  "Owner": "testadb"
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2025-11-05新增 OpenAPI查看变更详情