DescribeDBNodesParameters - PolarDB - Alibaba Cloud Documentation Center

Queries the parameters of a specified node in a 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

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:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is 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:DescribeDBNodesParameters	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	pc-****************
DBNodeIds	string	Yes	The node ID. You can specify multiple node IDs. Separate multiple node IDs with commas (,).	pi-**************,pi-**************

Response parameters

Parameter	Type	Description	Example
	object
DBVersion	string	The version of the MySQL database engine. Valid values: 5.6 5.7 8.0	5.6
RequestId	string	The request ID.	9B7BFB11-C077-4FE3-B051-F69CEB******
DBType	string	The type of the database engine. Set the value to MySQL.	MySQL
Engine	string	The cluster engine.	POLARDB
DBNodeIds	object []	The IDs of the nodes.
DBNodeId	string	The ID of the node.	pi-bp1r4qe3s534*****
RunningParameters	object []	The parameters of the current node.
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
DefaultParameterValue	string	The default value of the parameter.	utf8
ForceRestart	boolean	Indicates whether a cluster restart is required to allow the parameter modification to take effect. Valid values: false true	true
IsModifiable	boolean	Indicates whether the parameter can be modified. Valid values: false true	true
ParameterDescription	string	The description of the parameter.	The server's default character set.
ParameterName	string	The name of the parameter.	character_set_server
ParameterStatus	string	The status of the parameter. Valid values: normal modifying	normal
ParameterValue	string	The value of the parameter.	utf8
IsNodeAvailable	string	Indicates whether the parameter is a global parameter. Valid values: 0: yes. The modified parameter value is synchronized to other nodes. 1: no. You can customize the nodes to which the modified parameter value can be synchronized to.	1
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

Examples

Sample success responses

JSONformat

{
  "DBVersion": "5.6",
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "DBType": "MySQL",
  "Engine": "POLARDB",
  "DBNodeIds": [
    {
      "DBNodeId": "pi-bp1r4qe3s534*****",
      "RunningParameters": [
        {
          "CheckingCode": "[utf8|latin1|gbk|utf8mb4]",
          "DataType": "INT",
          "DefaultParameterValue": "utf8",
          "ForceRestart": true,
          "IsModifiable": true,
          "ParameterDescription": "The server's default character set.",
          "ParameterName": "character_set_server",
          "ParameterStatus": "normal",
          "ParameterValue": "utf8",
          "IsNodeAvailable": "1",
          "ParamRelyRule": "utf8",
          "Factor": "20"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBNodeId.Malformed	The specified parameter DBNodeId is not valid.	The specified DBNodeId parameter is invalid.
400	InvalidDBType.Malformed	The Specified DBType is not valid.	The specified database type is invalid.
404	InvalidDBCluster.NotFound	The specified DBClusterId is not found.	The specified cluster ID does not exist.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.