全部产品
Search

搜索本产品

    云原生数据库 PolarDB：DescribeDBInitializeVariable - 查询数据库属性

    文档中心

    云原生数据库 PolarDB：DescribeDBInitializeVariable - 查询数据库属性

    更新时间：Sep 05, 2024

    查询PolarDB数据库支持的字符集、排序规则等属性。

    调试

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

    授权信息

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

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

    请求参数

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

    集群 ID。

    说明 您可以调用 DescribeDBClusters 接口查看目标地域下的所有集群信息，包括集群 ID。
    		pc-****************

    返回参数

    名称类型描述示例值
    object
    Variablesarray<object>

    结果集。

    object
    Charsetstring

    支持的字符集。

    		EUC_CN
    Collatestring

    语言环境设置，用于指定新建数据库的排序规则。

    说明
  • 语言环境必须与 CharacterSetName 参数设置的字符集兼容。
  • 当集群为 PolarDB PostgreSQL 版（兼容 Oracle）或 PolarDB PostgreSQL 版时，该参数必填。
    •

    关于该参数的取值范围，请登录 PolarDB 控制台，在配置与管理 > 数据库管理页签，单击创建数据库进行查看。

    		C
    Ctypestring

    语言环境设置，用于指定数据库的字符分类。

    说明
  • 语言环境必须与 CharacterSetName 参数设置的字符集兼容。
  • 与 Collate 传入信息一致。
  • 当集群为 PolarDB PostgreSQL 版（兼容 Oracle）或 PolarDB PostgreSQL 版时，该参数必填；当集群为 PolarDB MySQL 版时，不支持该参数。
    •

    关于该参数的取值范围，请登录 PolarDB 控制台，在配置与管理 > 数据库管理页签，单击创建数据库进行查看。

    		C
    DBVersionstring

    数据库版本。

    		11
    RequestIdstring

    请求 ID。

    		475F58B7-F394-4394-AA6E-4F1CBA******
    DBTypestring

    数据库类型，取值如下：

    • Oracle
    • PostgreSQL
    • MySQL
    		PostgreSQL

    示例

    正常返回示例

    JSON格式

    {
  "Variables": {
    "Variable": [
      {
        "Charset": "EUC_CN",
        "Collate": "C",
        "Ctype": "C"
      }
    ]
  },
  "DBVersion": "11",
  "RequestId": "475F58B7-F394-4394-AA6E-4F1CBA******",
  "DBType": "PostgreSQL"
}

    错误码

    HTTP status code错误码错误信息描述
    400InvalidDBType.MalformedThe Specified DBType is not valid.指定的数据库类型无效.
    404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的 DBClusterId。
    404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效

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

    变更历史

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