调用DescribeDBInitializeVariable接口查询PolarDB O引擎或PolarDB PostgreSQL引擎数据库支持的字符集、排序规则等属性。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBInitializeVariable

系统规定参数。取值:DescribeDBInitializeVariable

DBClusterId String pc-****************

集群ID。

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

返回数据

名称 类型 示例值 描述
Variables Array of Variable

结果集。

Variable
Charset String EUC_CN

支持的字符集。

Collate String C

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

说明
  • 语言环境必须与CharacterSetName参数设置的字符集兼容。
  • 当集群为PolarDB O引擎或PolarDB PostgreSQL引擎时,该参数必填;
  • 当集群为PolarDB MySQL引擎时,该参数非必填。

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

Ctype String C

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

说明
  • 语言环境必须与CharacterSetName参数设置的字符集兼容。
  • Collate传入信息一致。
  • 当集群为PolarDB O引擎或PolarDB PostgreSQL引擎时,该参数必填;
  • 当集群为PolarDB MySQL引擎时,该参数非必填。

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

DBVersion String 11

数据库版本。

RequestId String 475F58B7-F394-4394-AA6E-4F1CBA******

请求ID。

DBType String PostgreSQL

数据库类型,取值如下:

  • Oracle
  • PostgreSQL

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeDBInitializeVariable
&DBClusterId=pc-****************
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ResponseResponse>
	<Variables>
		<Variable>
			<Charset>EUC_CN</Charset>
			<Collate>C</Collate>
			<Ctype>C</Ctype>
		</Variable>
		<Variable>
			<Charset>EUC_CN</Charset>
			<Collate>POSIX</Collate>
			<Ctype>POSIX</Ctype>
		</Variable>
	</Variables>
	<DBVersion>11</DBVersion>
	<RequestId>475F58B7-F394-4394-AA6E-4F1CBA1F2FE8</RequestId>
	<DBType>PostgreSQL</DBType>
</ResponseResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的 DBClusterId。

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