You can call this operation to query the parameters of a specified ApsaraDB for 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
DBClusterId String Yes pc-xxxxxxxxxx

The ID of the cluster.

AccessKeyId String No key-test

The AccessKey ID provided to you by Alibaba Cloud.

Action String No DescribeDBClusterParameters

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

Response parameters

Parameter Type Example Description
DBType String MySQL

The type of the database. Valid values:

  • MySQL
  • PostgreSQL
  • Oracle
DBVersion String 5.6

The version of the database engine. Valid values:

  • MySQL: 5.6 or 8.0
  • PostgreSQL: 11
  • Oracle: 11
Engine String ApsaraDB for PolarDB

The engine of the cluster.

RequestId String 0FF7F658-ECE2-476C-B3C5-122BA9EB43C6

The ID of the request.

RunningParameters Array

The list of running parameters of the cluster.

Parameter

The list of running parameters of the cluster.

CheckingCode String [utf8|latin1|gbk|utf8mb4]

The verification code of the parameter, which indicates the valid values of the parameter.

DataType String STRING

The value type of the parameter.

DefaultParameterValue String utf8

The default value of the parameter.

ForceRestart Boolean true

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

  • False
  • True
IsModifiable Boolean true

Indicates whether the parameter can be modified. Valid values:

  • False: The parameter cannot be modified.
  • True: The parameter can be modified.
ParameterDescription String The server's default character set.

The description of the parameter.

ParameterName String character_set_server

The name of the parameter.

ParameterStatus String Normal

The status of the parameter. Valid values:

  • normal
  • modifying
ParameterValue String utf8

The value of parameter.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeDBClusterParameters
&DBClusterId=pc-xxxxxxxxxx
&<Common request parameters>

Sample success responses

XML format

<RequestId>85DC8A9E-4E3E-4107-A569-A92B1D9C5B7C</RequestId>
<RunningParameters>
    <Parameter>
        <ParameterStatus>Normal</ParameterStatus>
        <DefaultParameterValue>1</DefaultParameterValue>
        <IsModifiable>true</IsModifiable>
        <DataType>INT</DataType>
        <ParameterDescription>Auto-increment columns are incremented by this</ParameterDescription>
        <ParameterValue>1</ParameterValue>
        <CheckingCode>[1-65535]</CheckingCode>
        <ForceRestart>false</ForceRestart>
        <ParameterName>auto_increment_increment</ParameterName>
    </Parameter>
    <Parameter>
        <ParameterStatus>Normal</ParameterStatus>
        <DefaultParameterValue>86400</DefaultParameterValue>
        <IsModifiable>true</IsModifiable>
        <DataType>INT</DataType>
        <ParameterDescription>The number of seconds the server waits for activity on a connection before closing it</ParameterDescription>
        <ParameterValue>86400</ParameterValue>
        <CheckingCode>[1-31536000]</CheckingCode>
        <ForceRestart>false</ForceRestart>
        <ParameterName>wait_timeout</ParameterName>
    </Parameter>
</RunningParameters>
<Engine>PolarDB</Engine>

JSON format

{
	"RequestId":"85DC8A9E-4E3E-4107-A569-A92B1D9C5B7C",
	"RunningParameters":{
		"Parameter":[
			{
				"DefaultParameterValue":"1",
				"ParameterStatus":"Normal",
				"DataType":"INT",
				"IsModifiable":true,
				"ParameterDescription":"Auto-increment columns are incremented by this",
				"ParameterValue":"1",
				"ForceRestart":false,
				"CheckingCode":"[1-65535]",
				"ParameterName":"auto_increment_increment"
			},
			{
				"DefaultParameterValue":"86400",
				"ParameterStatus":"Normal",
				"DataType":"INT",
				"IsModifiable":true,
				"ParameterDescription":"The number of seconds the server waits for activity on a connection before closing it",
				"ParameterValue":"86400",
				"ForceRestart":false,
				"CheckingCode":"[1-31536000]",
				"ParameterName":"wait_timeout"
			}
		]
	},
	"Engine":"PolarDB"
}

Error codes

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