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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDBNodesParameters

The operation that you want to perform. Set the value to DescribeDBNodesParameters.

DBClusterId String Yes pc-****************

The ID of the cluster.

DBNodeIds String Yes pi-****************,pi-****************

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

Response parameters

Parameter Type Example Description
DBVersion String 5.6

The version of the MySQL engine. Valid values:

  • 5.6
  • 5.7
  • 8.0
RequestId String 9B7BFB11-C077-4FE3-B051-F69CEB******

The ID of the request.

DBType String MySQL

The database engine that the cluster runs. Set the value to MySQL.

Engine String POLARDB

The cluster engine.

DBNodeIds Array of DBNodeParameter

The IDs of nodes to which the node belong.

DBNodeId String pi-bp1r4qe3s534*****

The ID of the node.

RunningParameters Array of Parameter

The running parameters of the current node.

CheckingCode String [utf8|latin1|gbk|utf8mb4]

The valid values of the parameter.

DataType String INT

The data type of the parameter value. Valid values:

  • INT
  • STRING
  • B
DefaultParameterValue String utf8

The default value of the parameter.

ForceRestart Boolean true

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

  • false
  • true
IsModifiable Boolean true

Indicates whether the parameter setting can be modified. Valid values:

  • false
  • true
ParameterDescription String The server's default character set.

Indicates the description of the parameter.

ParameterName String character_set_server

The name of the parameter.

ParameterStatus String normal

The status of the parameter. Valid values:

  • normal
  • modifying
ParameterValue String utf8

Indicates the value of the parameter.

IsNodeAvailable String 1

Indicates whether the parameter is a global parameter. Valid values:

  • 0: yes. The modified parameter value is synchronized to other nodes by default.
  • 1: no. You can customize the nodes the modified parameter value can be synchronized to.
ParamRelyRule String utf8

The parameter dependencies.

Factor String 20

A divisor of an integer. For a parameter of the integer or byte type, the value must be a multiple of a factor (not equal to 0) in addition to within the specified range.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=DescribeDBNodesParameters
&DBClusterId=pc-****************
&DBNodeIds=pi-****************,pi-****************
&<Common request parameters>

Sample success response

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

HttpCode Error code Error message Description
404 InvalidDBCluster.NotFound The specified DBClusterId is not found. The error message returned because the specified cluster instance ID does not exist.
404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified DBClusterId does not exist in the current record.

For a list of error codes, visit the API Error Center.