DescribeDBInitializeVariable - PolarDB - Alibaba Cloud Documentation Center

Queries attributes such as character sets and collations supported by a database in a PolarDB cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
polardb:DescribeDBInitializeVariable	get	dbcluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of cluster. Note You can call the DescribeDBClusters operation to query information about all clusters that are deployed in a specified region, such as the cluster ID.	pc-****************

Response parameters

Parameter	Type	Description	Example
	object
Variables	array<object>	The attributes that are returned.
	object
Charset	string	The character set that is supported.	EUC_CN
Collate	string	The language that indicates the collation of the databases that are created. Note The language must be compatible with the character set that is specified by CharacterSetName. This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters. This parameter is optional for PolarDB for MySQL clusters. To view the valid values for this parameter, perform the following steps: Log on to the PolarDB console and click the ID of a cluster. In the left-side navigation pane, choose Settings and Management > Databases. Then, click Create Database.	C
Ctype	string	The language that indicates the character type of the database. Note The language must be compatible with the character set that is specified by CharacterSetName. The specified parameter value must be the same as the value of Collate. If the PolarDB cluster runs PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL, this parameter is required. If the cluster runs PolarDB for MySQL, this parameter is not supported. To view the valid values of this parameter, perform the following steps: First, log on to the PolarDB console and click the ID of a cluster. Then, in the left-side navigation pane, choose Settings and Management > Databases. Finally, click Create Database.	C
DBVersion	string	The version of the database engine.	11
RequestId	string	The ID of the request.	475F58B7-F394-4394-AA6E-4F1CBA******
DBType	string	The database type. Valid values: Oracle PostgreSQL MySQL	PostgreSQL

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBType.Malformed	The Specified DBType is not valid.	The specified database type is invalid.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-09-12	The Error code has changed	View Change Details