DescribeDBNodesParameters - PolarDB - Alibaba Cloud Documentation Center

Queries the parameters for specified nodes in a 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:DescribeDBNodesParameters

get

*DBCluster

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

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
DBVersion	string	The version of the MySQL database. Valid values: 5.6 5.7 8.0	5.6
RequestId	string	The ID of the request.	9B7BFB11-C077-4FE3-B051-F69CEB******
DBType	string	The type of the database. The value is fixed as MySQL.	MySQL
Engine	string	The database engine of the cluster.	POLARDB
DBNodeIds	array<object>	The list of node IDs.
	array<object>
DBNodeId	string	The ID of the node.	pi-bp1r4qe3s534*****
RunningParameters	array<object>	The list of parameters that are running on the node.
	object
CheckingCode	string	The valid values of the parameter.	[utf8\|latin1\|gbk\|utf8mb4]
DataType	string	The data type of the parameter. Valid values: INT: Integer STRING: String B: Byte	INT
DefaultParameterValue	string	The default value of the parameter.	utf8
ForceRestart	boolean	Indicates whether a restart is required for the parameter modification to take effect. Valid values: false: No true: Yes	true
IsModifiable	boolean	Indicates whether the parameter can be modified. Valid values: false: No true: Yes	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: Normal modifying: Modifying	normal
ParameterValue	string	The value of the parameter.	utf8
IsNodeAvailable	string	Indicates whether the parameter is a global parameter. Valid values: 0: The parameter is a global parameter. Modifications to the parameter are applied to other nodes by default and cannot be canceled. 1: The parameter is not a global parameter. You can specify the nodes to which you want to apply the parameter modifications.	1
ParamRelyRule	string	The dependency of the parameter.	utf8
Factor	string	The divisor. For integer and byte type parameters, the parameter value must be a multiple of this factor. The factor cannot be 0.	20

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.