All Products
Search
Document Center

PolarDB:DescribeDBClusterParameters

Last Updated:Mar 01, 2024

Queries the parameters of a PolarDB cluster.

Debugging

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

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:DescribeDBClusterParametersREAD
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the cluster.

pc-**********
DescribeTypestringNo

The kernel parameter. Valid values:

  • Normal: the kernel parameters.
  • MigrationFromRDS: compares the current parameters with the parameters of the source RDS instance.
Normal

Response parameters

ParameterTypeDescriptionExample
object
RunningParametersobject []

The parameters that are in use.

CheckingCodestring

The valid values of the parameter.

[utf8|latin1|gbk|utf8mb4]
DataTypestring

The data type of the parameter value. Valid values:

  • INT
  • STRING
  • B
INT
ParameterNamestring

The name of the parameter.

character_set_server
ParameterValuestring

The value of the parameter.

utf8
ForceRestartboolean

Indicates whether a cluster restart is required to allow the parameter modification to take effect. Valid values:

  • false
  • true
true
ParameterDescriptionstring

The description of the parameter.

The server's default character set.
ParameterStatusstring

The status of the parameter. Valid values:

  • Normal
  • Modifying
Normal
DefaultParameterValuestring

The default value of the parameter.

utf8
IsModifiableboolean

Indicates whether the parameter can be modified. Valid values:

  • false
  • true
true
IsNodeAvailablestring

Indicates whether the parameter is a global parameter. Valid values:

  • 0: yes. The modified parameter value is synchronized to other nodes.
  • 1: no. You can customize the nodes to which the modified parameter value can be synchronized.
0
ParamRelyRulestring

The dependencies of the parameter.

utf8
Factorstring

A divisor of the parameter. For a parameter of the integer or byte type, the valid values must be a multiple of Factor unless you set Factor to 0.

20
DBVersionstring

The version of the database engine.

  • Valid values for the MySQL database engine: - 5.6
    • 5.7
    • 8.0
  • Valid value for the PostgreSQL database engine: - 11
    • 14
  • Valid value for the Oracle database engine: 11
5.6
RequestIdstring

The ID of the request.

EBEAA83D-1734-42E3-85E3-E25F6E******
DBTypestring

The database engine that the cluster runs. Valid values:

  • MySQL
  • PostgreSQL
  • Oracle
MySQL
Enginestring

The cluster engine.

POLARDB
DBClusterIdstring

The ID of the cluster.

pc-bp1s826a1up******
ParameterNumbersstring

The number of parameters.

1
Parametersobject []

A comparison between the current parameters of the PolarDB cluster and the parameters of the source RDS instance before migration.

rdsParameterNamestring

The name of the parameter of the source instance.

character_set_server
rdsParameterValuestring

The value of the parameter of the source instance.

utf8
rdsParameterOptionalstring

The valid values of the parameter of the source instance.

- utf8 - gbk
distParameterNamestring

The name of the parameter of the current cluster.

character_set_server
distParameterValuestring

The value of the parameter of the current cluster.

utf8
distParameterOptionalstring

The valid values of the parameter of the current cluster.

- utf8 - gbk
IsEqualstring

Indicates whether the source parameters and current parameters have the same value.

true
distParameterDescriptionstring

The description of the parameter of the current cluster.

The server's default character set.
rdsParameterDescriptionstring

The description of the parameter of the source instance.

The server's default character set.

Examples

Sample success responses

JSONformat

{
  "RunningParameters": {
    "Parameter": [
      {
        "CheckingCode": "[utf8|latin1|gbk|utf8mb4]",
        "DataType": "INT",
        "ParameterName": "character_set_server",
        "ParameterValue": "utf8",
        "ForceRestart": true,
        "ParameterDescription": "The server's default character set.",
        "ParameterStatus": "Normal",
        "DefaultParameterValue": "utf8",
        "IsModifiable": true,
        "IsNodeAvailable": "0",
        "ParamRelyRule": "utf8",
        "Factor": "20"
      }
    ]
  },
  "DBVersion": "5.6",
  "RequestId": "EBEAA83D-1734-42E3-85E3-E25F6E******",
  "DBType": "MySQL",
  "Engine": "POLARDB",
  "DBClusterId": "pc-bp1s826a1up******\t\n",
  "ParameterNumbers": "1",
  "Parameters": {
    "Parameters": [
      {
        "rdsParameterName": "character_set_server",
        "rdsParameterValue": "utf8",
        "rdsParameterOptional": "- utf8\n- gbk",
        "distParameterName": "character_set_server",
        "distParameterValue": "utf8",
        "distParameterOptional": "- utf8\n- gbk",
        "IsEqual": "true",
        "distParameterDescription": "The server's default character set.",
        "rdsParameterDescription": "The server's default character set."
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.
403Forbidden.RAMUser not authorized to operate on the specified resource, or this API does not support RAM.-
404InvalidDBClusterId.NotFoundThe DBInstanceId 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
2024-02-29The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
Output ParametersThe response structure of the API has changed.
2023-06-12The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    Added Error Codes: 403
    Added Error Codes: 404
2023-06-08The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: DescribeType
Output ParametersThe response structure of the API has changed.
2022-07-18The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2022-02-24The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.