Queries the parameters of a specified PolarDB cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDBClusterParameters

The operation that you want to perform. Set the value to DescribeDBClusterParameters.

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

The ID of the cluster.

Response parameters

Parameter Type Example Description
RunningParameters Array of Parameter

The parameters that are in use.

Parameter
CheckingCode String [utf8|latin1|gbk|utf8mb4]

The valid values of the parameter.

DataType String INT

The data type of the parameter value. Valid values:

  • INT
  • STRING
  • B
ParameterName String character_set_server

The name of the parameter.

ParameterValue String utf8

The value of the parameter.

ForceRestart Boolean true

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

  • false
  • true
ParameterDescription String The server's default character set.

The description of the parameter.

ParameterStatus String Normal

The status of the parameter. Valid values:

  • Normal
  • Modifying
DefaultParameterValue String utf8

The default value of the parameter.

IsModifiable Boolean true

Indicates whether the parameter setting can be modified. Valid values:

  • false
  • true
IsNodeAvailable String 0

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

  • 0: yes. The modified parameter value is synchronized to other nodes by default.
  • 1: no. You can customize the nodes the modified parameter value can be synchronized to.
ParamRelyRule String utf8

The parameter dependencies.

Factor String 20

A divisor of an integer. For a parameter of the integer or byte type, the value must be a multiple of a factor (not equal to 0) in addition to within the specified range.

DBVersion String 5.6

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
RequestId String EBEAA83D-1734-42E3-85E3-E25F6E******

The ID of the request.

DBType String MySQL

The database engine that the cluster runs. Valid values:

  • MySQL
  • PostgreSQL
  • Oracle
Engine String POLARDB

The cluster engine.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=DescribeDBClusterParameters
&ResourceOwnerId=1
&DBClusterId=pc-**********
&Common request parameters

Sample success responses

XML format 

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

<DescribeDBClusterParametersResponse>
    <RunningParameters>
        <CheckingCode>[utf8|latin1|gbk|utf8mb4]</CheckingCode>
        <DataType>INT</DataType>
        <ParameterName>character_set_server</ParameterName>
        <ParameterValue>utf8</ParameterValue>
        <ForceRestart>true</ForceRestart>
        <ParameterDescription>The server's default character set.</ParameterDescription>
        <ParameterStatus>Normal</ParameterStatus>
        <DefaultParameterValue>utf8</DefaultParameterValue>
        <IsModifiable>true</IsModifiable>
        <IsNodeAvailable>0</IsNodeAvailable>
        <ParamRelyRule>utf8</ParamRelyRule>
        <Factor>20</Factor>
    </RunningParameters>
    <DBVersion>5.6</DBVersion>
    <RequestId>EBEAA83D-1734-42E3-85E3-E25F6E******</RequestId>
    <DBType>MySQL</DBType>
    <Engine>POLARDB</Engine>
</DescribeDBClusterParametersResponse>

JSON format 

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

{
  "RunningParameters" : [ {
    "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"
}

Error codes

HttpCode Error code Error message Description
400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. The error message returned because the specified DBClusterId parameter is invalid.

For a list of error codes, visit the Error Center.