DescribeDBClusterParameters - PolarDB - Alibaba Cloud Documentation Center

Queries the list of running parameters for a PolarDB cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeDBClusterParameters

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	pc-**********
DescribeType	string	No	The kernel parameters. Valid values: Normal: The list of kernel parameters. MigrationFromRDS: Compares parameters with those of an ApsaraDB RDS instance.	Normal

Response elements

Element	Type	Description	Example
	object
RunningParameters	object
Parameter	array<object>	The list of current running parameters in the PolarDB cluster.
	object
CheckingCode	string	The valid range of values for the parameter.	[utf8\|latin1\|gbk\|utf8mb4]
DataType	string	The data type of the parameter value. Valid values: INT: integer. STRING: string. B: byte.	INT
ParameterName	string	The parameter name.	character_set_server
ParameterValue	string	The parameter value.	utf8
ForceRestart	boolean	Indicates whether a restart is required for the parameter to take effect. Valid values: false: A restart is not required. true: A restart is required.	true
ParameterDescription	string	The parameter description.	The server's default character set.
ParameterStatus	string	The status of the parameter. Valid values: Normal: The parameter is in the normal state. Modifying: The parameter is being modified.	Normal
DefaultParameterValue	string	The default value of the parameter.	utf8
IsModifiable	boolean	Indicates whether the parameter can be modified. Valid values: false: The parameter cannot be modified. true: The parameter can be modified.	true
IsNodeAvailable	string	Indicates whether the parameter is a global parameter. Valid values: 0: The parameter is a global parameter. After the parameter is modified, its new value is synchronized to other nodes by default. 1: The parameter is not a global parameter. You can specify the nodes to which the modified parameter value is synchronized.	0
ParamRelyRule	string	The parameter dependencies.	utf8
Factor	string	The division factor. For integer and byte type parameters, the parameter value must be a multiple of Factor (which cannot be 0) and fall within the valid value range.	20
DBVersion	string	The database engine version. Valid values for MySQL: 5.6 5.7 8.0 Valid values for PostgreSQL: 11 14 Valid values for Oracle: 11 14	5.6
RequestId	string	The request ID.	EBEAA83D-1734-42E3-85E3-E25F6E******
DBType	string	The database type. Valid values: MySQL PostgreSQL Oracle	MySQL
Engine	string	The engine.	POLARDB
DBClusterId	string	The cluster ID.	pc-bp1s826a1up******
ParameterNumbers	string	The number of parameters.	1
Parameters	object
Parameters	array<object>	The list of parameter comparison results for an instance migration from ApsaraDB RDS to PolarDB.
	object
rdsParameterName	string	The name of the source instance parameter.	character_set_server
rdsParameterValue	string	The value of the source instance parameter.	utf8
rdsParameterOptional	string	The valid values of the source instance parameter.	- utf8 - gbk
distParameterName	string	The name of the cluster parameter.	character_set_server
distParameterValue	string	The value of the cluster parameter.	utf8
distParameterOptional	string	The valid values of the cluster parameter.	- utf8 - gbk
IsEqual	string	Indicates whether the parameter values are the same.	true
distParameterDescription	string	The description of the cluster parameter.	The server's default character set.
rdsParameterDescription	string	The description of the source instance parameter.	The server's default character set.
IsRdsKey	string	Indicates whether the parameter is a key parameter of the source instance. Valid values: 1: The parameter is a key parameter of the source instance. 0: The parameter is not a key parameter of the source instance.	1
IsPolarDBKey	string	Indicates whether the parameter is a key parameter of the destination instance. 1: The parameter is a key parameter of the destination instance. 0: The parameter is not a key parameter of the destination instance.	0
IsInstancePolarDBKey	string	Indicates whether the parameter is a key parameter of the destination instance. 1: The parameter is a key parameter of the destination instance. 0: The parameter is not a key parameter of the destination instance.	1
IsInstanceRdsKey	string	Indicates whether the parameter is a key parameter of the source instance. 1: The parameter is a key parameter of the source instance. 0: The parameter is not a key parameter of the source instance.	0

Examples

Success response

JSON format

{
  "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.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.