调用DescribeDBNodesParameters接口查询集群中指定节点的参数。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBNodesParameters

系统规定参数。取值:DescribeDBNodesParameters

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

集群ID。

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

节点ID。支持传入多个节点ID,多个节点ID间用英文逗号(,)分隔。

返回数据

名称 类型 示例值 描述
DBVersion String 5.6

MySQL版本号。取值范围:

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

请求ID。

DBType String MySQL

数据库类型。取值固定为MySQL

Engine String POLARDB

集群引擎。

DBNodeIds Array of DBNodeParameter

节点ID列表。

DBNodeId String pi-bp1r4qe3s534*****

节点ID。

RunningParameters Array of Parameter

当前节点运行的参数列表。

CheckingCode String [utf8|latin1|gbk|utf8mb4]

目标参数的取值范围。

DataType String INT

参数值类型。取值范围:

  • INT:整数类型
  • STRING:字符串类型
  • B:字节类型
DefaultParameterValue String utf8

参数默认值。

ForceRestart Boolean true

是否需要重启生效。取值范围:

  • false:否
  • true:是
IsModifiable Boolean true

是否可修改。取值范围:

  • false:不可修改
  • true:可修改
ParameterDescription String The server's default character set.

参数描述。

ParameterName String character_set_server

参数名称。

ParameterStatus String normal

参数状态。取值范围:

  • normal:正常
  • modifying:修改中
ParameterValue String utf8

参数值。

IsNodeAvailable String 1

是否是全局参数。取值范围:

  • 0:是全局参数。参数修改会默认应用到其他节点,且不可取消;
  • 1:不是全局参数。参数修改可自定义应用到其他节点。
ParamRelyRule String utf8

参数依赖。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeDBNodesParameters
&DBClusterId=pc-****************
&DBNodeIds=pi-****************,pi-****************
&公共请求参数

正常返回示例

XML格式

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>
        </RunningParameters>
    </DBNodeIds>
</DescribeDBNodesParametersResponse>

JSON格式

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"
    } ]
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBCluster.NotFound The specified DBClusterId is not found. 操作失败,指定的集群实例ID不存在。

访问错误中心查看更多错误码。