All Products
Search
Document Center

PolarDB:DescribeDBNodesParameters

Last Updated:Oct 10, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:DescribeDBNodesParametersget
  • DBCluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID.

pc-****************
DBNodeIdsstringYes

The node ID. You can specify multiple node IDs. Separate multiple node IDs with commas (,).

pi-****************,pi-****************

Response parameters

ParameterTypeDescriptionExample
object
DBVersionstring

The version of the MySQL database engine. Valid values:

  • 5.6
  • 5.7
  • 8.0
5.6
RequestIdstring

The request ID.

9B7BFB11-C077-4FE3-B051-F69CEB******
DBTypestring

The type of the database engine. Set the value to MySQL.

MySQL
Enginestring

The cluster engine.

POLARDB
DBNodeIdsarray<object>

The IDs of the nodes.

DBNodeParameterobject
DBNodeIdstring

The ID of the node.

pi-bp1r4qe3s534*****
RunningParametersarray<object>

The parameters of the current node.

Parameterobject
CheckingCodestring

The valid values of the parameter.

[utf8|latin1|gbk|utf8mb4]
DataTypestring

The data type of the parameter value. Valid values:

  • INT
  • STRING
  • B
INT
DefaultParameterValuestring

The default value of the parameter.

utf8
ForceRestartboolean

Indicates whether a cluster restart is required to allow the parameter modification to take effect. Valid values:

  • false
  • true
true
IsModifiableboolean

Indicates whether the parameter can be modified. Valid values:

  • false
  • true
true
ParameterDescriptionstring

The description of the parameter.

The server's default character set.
ParameterNamestring

The name of the parameter.

character_set_server
ParameterStatusstring

The status of the parameter. Valid values:

  • normal
  • modifying
normal
ParameterValuestring

The value of the parameter.

utf8
IsNodeAvailablestring

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
ParamRelyRulestring

The dependencies of the parameter.

utf8
Factorstring

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 codeError codeError messageDescription
400InvalidDBNodeId.MalformedThe specified parameter DBNodeId is not valid.The specified DBNodeId parameter is invalid.
400InvalidDBType.MalformedThe Specified DBType is not valid.The specified database type is invalid.
404InvalidDBCluster.NotFoundThe specified DBClusterId is not found.The specified cluster ID does not exist.
404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-12The Error code has changedView Change Details
2022-07-18The Error code has changed. The response structure of the API has changedView Change Details
2022-02-24The Error code has changed. The response structure of the API has changedView Change Details
2022-02-24Add OperationView Change Details