Queries the parameters of a PolarDB cluster.
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| polardb:DescribeDBClusterParameters | get | *dbcluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBClusterId | string | Yes | The ID of the cluster. | pc-********** |
| DescribeType | string | No | The type of the parameter information to query. Valid values:
| Normal |
Response parameters
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.",
"IsRdsKey": 1,
"IsPolarDBKey": 0,
"IsInstancePolarDBKey": 1,
"IsInstanceRdsKey": 0
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | The specified DBClusterId parameter is invalid. |
| 403 | Forbidden.RAM | User not authorized to operate on the specified resource, or this API does not support RAM. | - |
| 404 | InvalidDBClusterId.NotFound | The 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 time | Summary of changes | Operation |
|---|---|---|
| 2024-02-29 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-06-12 | The Error code has changed | View Change Details |
| 2023-06-08 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2022-07-18 | The response structure of the API has changed | View Change Details |
| 2022-02-24 | The response structure of the API has changed | View Change Details |