DescribeDBInitializeVariable - PolarDB - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeDBInitializeVariable

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. Note Call the DescribeDBClusters operation to view information about all clusters in the destination region, including cluster IDs.	pc-****************

Response elements

Element	Type	Description	Example
	object
Variables	object
Variable	array<object>	The result set.
	object
Charset	string	The supported character set.	EUC_CN
Collate	string	The locale setting that specifies the collation for a new database. Note The locale must be compatible with the character set specified by the CharacterSetName parameter. This parameter is required when the cluster is a PolarDB for PostgreSQL (Oracle Compatible) or PolarDB for PostgreSQL cluster. To view the valid values for this parameter, log on to the PolarDB console, go to the Configuration and Management > Database Management tab, and click Create Database.	C
Ctype	string	The locale setting that specifies the character classification for the database. Note The locale must be compatible with the character set specified by the CharacterSetName parameter. The value must be the same as the value of the Collate parameter. This parameter is required when the cluster is a PolarDB for PostgreSQL (Oracle Compatible) or PolarDB for PostgreSQL cluster. This parameter is not supported for PolarDB for MySQL clusters. To view the valid values for this parameter, log on to the PolarDB console, go to the Configuration and Management > Database Management tab, and click Create Database.	C
DBVersion	string	The database version.	11
RequestId	string	The request ID.	475F58B7-F394-4394-AA6E-4F1CBA******
DBType	string	The database type. Valid values: Oracle PostgreSQL MySQL	PostgreSQL

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.