All Products
Search
Document Center

PolarDB:DescribeDBInitializeVariable

Last Updated:Nov 07, 2023

Queries the attributes that are supported by a PolarDB for PostgreSQL (Compatible with Oracle) cluster or a PolarDB for PostgreSQL cluster, such as the character sets and collations.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

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.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:DescribeDBInitializeVariableREAD
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

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

ParameterTypeDescriptionExample
object
Variablesobject []

The attributes that are returned.

Charsetstring

The character set that is supported.

EUC_CN
Collatestring

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
    Ctypestring

    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 value must be the same as the value of Collate.
  • 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
    DBVersionstring

    The version of the database engine.

    11
    RequestIdstring

    The ID of the request.

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

    The type of the database engine. Valid values:

    • Oracle
    • PostgreSQL
    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 codeError codeError messageDescription
    404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.

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

    Change history

    Change timeSummary of changesOperation
    2023-09-12The error codes of the API operation change.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 404 change
      Added Error Codes: 400