Queries the parameters of a specified PolarDB cluster.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | No | DescribeDBClusterParameters |
The operation that you want to perform. Set the value to ModifyDBClusterParameters. |
DBClusterId | String | Yes | pc-********** |
The ID of the cluster. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
DBType | String | MySQL |
The type of the database engine. Valid values:
|
DBVersion | String | 5.6 |
The version number of the database engine.
|
Engine | String | POLARDB |
The engine. |
RequestId | String | EBEAA83D-1734-42E3-85E3-E25F6E****** |
The ID of the request. |
RunningParameters | Array of Parameter |
The parameters that are in use. |
|
Parameter | |||
CheckingCode | String | [utf8|latin1|gbk|utf8mb4] |
The valid values of a parameter. |
DataType | String | INT |
The data type of the parameter value. |
DefaultParameterValue | String | utf8 |
The default value of the parameter. |
ForceRestart | Boolean | true |
Indicates whether a cluster restart is required to make the parameter modification take effect. Valid values:
|
IsModifiable | Boolean | true |
Indicates whether the parameter setting can be modified. Valid values:
|
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:
|
ParameterValue | String | utf8 |
The value of parameter. |
Examples
Sample requests
http(s)://polardb.aliyuncs.com/? Action=DescribeDBClusterParameters
&DBClusterId=pc-**********
&<Common request parameters>
Sample success responses
XML
format
<DescribeDBClusterParametersResponse>
<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>
<DefaultParameterValue>utf8</DefaultParameterValue>
<IsModifiable>true</IsModifiable>
<CheckingCode>[utf8|latin1|gbk|utf8mb4]</CheckingCode>
<ParameterValue>utf8</ParameterValue>
<ParameterStatus>Normal</ParameterStatus>
<ForceRestart>true</ForceRestart>
<DataType>STRING</DataType>
<ParameterName>character_set_server</ParameterName>
<ParameterDescription>The server's default character set. </ParameterDescription>
</Parameter>
</RunningParameters>
<DBVersion>5.6</DBVersion>
<RequestId>EBEAA83D-1734-42E3-85E3-E25F6E******</RequestId>
<DBType>MySQL</DBType>
<Engine>POLARDB</Engine>
</DescribeDBClusterParametersResponse>
JSON
format
{
"RunningParameters": {
"Parameter": [
{
"ParameterStatus": "Normal",
"DefaultParameterValue": 1,
"IsModifiable": true,
"DataType": "INT",
"ParameterDescription": "Auto-increment columns are incremented by this",
"ParameterValue": 1,
"CheckingCode": "[1-65535]",
"ForceRestart": false,
"ParameterName": "auto_increment_increment"
},
{
"DefaultParameterValue": "utf8",
"IsModifiable": true,
"CheckingCode": "[utf8|latin1|gbk|utf8mb4]",
"ParameterValue": "utf8",
"ParameterStatus": "Normal",
"ForceRestart": true,
"DataType": "STRING",
"ParameterName": "character_set_server",
"ParameterDescription": "The server's default character set."
}
]
},
"DBVersion": "5.6",
"RequestId": "EBEAA83D-1734-42E3-85E3-E25F6E******",
"DBType": "MySQL",
"Engine": "POLARDB"
}
Error codes
For a list of error codes, visit the API Error Center.