DescribeDBClusterParameters - PolarDB - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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: the information about the cluster parameters MigrationFromRDS: a comparison of parameters between the source RDS instance and the destination PolarDB cluster	Normal

Response parameters

Parameter	Type	Description	Example
	object
RunningParameters	array<object>	The parameters of the PolarDB cluster.
	object
CheckingCode	string	The valid values of the parameter.	[utf8\|latin1\|gbk\|utf8mb4]
DataType	string	The data type of the parameter value. Valid values: INT STRING B	INT
ParameterName	string	The name of the parameter.	character_set_server
ParameterValue	string	The value of the parameter.	utf8
ForceRestart	boolean	Indicates whether a cluster restart is required for the parameter modification to take effect. Valid values: false true	true
ParameterDescription	string	The description of the parameter.	The server's default character set.
ParameterStatus	string	The status of the parameter. Valid values: Normal Modifying	Normal
DefaultParameterValue	string	The default value of the parameter.	utf8
IsModifiable	boolean	Indicates whether the parameter can be modified. Valid values: false true	true
IsNodeAvailable	string	Indicates whether the parameter is a global parameter. Valid values: 0: The parameter is a global parameter. The modified parameter value is synchronized to other nodes. 1: The parameter is not a global parameter. You can specify the nodes to which the modified parameter value can be synchronized.	0
ParamRelyRule	string	The dependencies of the parameter.	utf8
Factor	string	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
DBVersion	string	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
RequestId	string	The ID of the request.	EBEAA83D-1734-42E3-85E3-E25F6E******
DBType	string	The database engine that the clusters runs. Valid values: MySQL PostgreSQL Oracle	MySQL
Engine	string	The cluster engine.	POLARDB
DBClusterId	string	The ID of the cluster.	pc-bp1s826a1up******
ParameterNumbers	string	The number of parameters.	1
Parameters	array<object>	A comparison of parameters between the source RDS instance and the destination PolarDB cluster.
	object
rdsParameterName	string	The name of the parameter of the source instance.	character_set_server
rdsParameterValue	string	The value of the parameter of the source instance.	utf8
rdsParameterOptional	string	The valid values of the parameter of the source instance.	- utf8 - gbk
distParameterName	string	The name of the parameter of the destination cluster.	character_set_server
distParameterValue	string	The value of the parameter of the destination cluster.	utf8
distParameterOptional	string	The valid values of the parameter of the destination cluster.	- utf8 - gbk
IsEqual	string	Indicates whether the source and current parameters have the same value.	true
distParameterDescription	string	The description of the parameter of the destination cluster.	The server's default character set.
rdsParameterDescription	string	The description of the parameter of the source instance.	The server's default character set.
IsRdsKey	string	Indicate whether the parameter is a primary parameter of the source instance. Valid values: 1: The parameter is a primary parameter of the source instance. 0: The parameter is not a primary parameter of the source instance.	1
IsPolarDBKey	string	Indicate whether the parameter is a primary parameter of the destination cluster. Valid values: 1: The parameter is a primary parameter of the destination cluster. 0: The parameter is not a primary parameter of the destination cluster.	0
IsInstancePolarDBKey	string	Indicate whether the parameter is a primary parameter of the destination cluster. Valid values: 1: The parameter is a primary parameter of the destination cluster. 0: The parameter is not a primary parameter of the destination cluster.	1
IsInstanceRdsKey	string	Indicate whether the parameter is a primary parameter of the source instance. Valid values: 1: The parameter is a primary parameter of the source instance. 0: The parameter is not a primary parameter of the source instance.	0

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