调用DescribeDBNodesParameters查询集群中指定节点的参数_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

查询集群中指定节点的参数。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
polardb:DescribeDBNodesParameters	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。	pc-****************
DBNodeIds	string	是	节点 ID。支持传入多个节点 ID，多个节点 ID 间用英文逗号（,）分隔。	pi-**************,pi-**************

返回参数

名称	类型	描述	示例值
	object
DBVersion	string	MySQL 版本号。取值范围： 5.6 5.7 8.0	5.6
RequestId	string	请求 ID。	9B7BFB11-C077-4FE3-B051-F69CEB******
DBType	string	数据库类型。取值固定为 MySQL。	MySQL
Engine	string	集群引擎。	POLARDB
DBNodeIds	object []	节点 ID 列表。
DBNodeId	string	节点 ID。	pi-bp1r4qe3s534*****
RunningParameters	object []	当前节点运行的参数列表。
CheckingCode	string	目标参数的取值范围。	[utf8\|latin1\|gbk\|utf8mb4]
DataType	string	参数值类型。取值范围： INT：整数类型 STRING：字符串类型 B：字节类型	INT
DefaultParameterValue	string	参数默认值。	utf8
ForceRestart	boolean	是否需要重启生效。取值范围： false：否 true：是	true
IsModifiable	boolean	是否可修改。取值范围： false：不可修改 true：可修改	true
ParameterDescription	string	参数描述。	The server's default character set.
ParameterName	string	参数名称。	character_set_server
ParameterStatus	string	参数状态。取值范围： normal：正常 modifying：修改中	normal
ParameterValue	string	参数值。	utf8
IsNodeAvailable	string	是否是全局参数。取值范围： 0：是全局参数。参数修改会默认应用到其他节点，且不可取消； 1：不是全局参数。参数修改可自定义应用到其他节点。	1
ParamRelyRule	string	参数依赖。	utf8
Factor	string	整除因子。对于整数和字节类型的参数，参数值除了必须满足参数的可选范围，还须是 Factor（不等于 0）的倍数。	20

示例

正常返回示例

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidDBNodeId.Malformed	The specified parameter DBNodeId is not valid.	指定的参数DBNodeId无效。
400	InvalidDBType.Malformed	The Specified DBType is not valid.	指定的数据库类型无效.
404	InvalidDBCluster.NotFound	The specified DBClusterId is not found.	操作失败，指定的集群实例ID不存在。
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	当前的记录中不存在提供的 DBClusterId。
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	指定的参数DBClusterId无效

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

变更历史

变更时间

变更内容概要

操作

2023-09-12

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	错误码 404 变更
	新增错误码：400

2022-07-18

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：404
出参	OpenAPI 返回结构发生变更。

2022-02-24

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：404
出参	OpenAPI 返回结构发生变更。

2022-02-24

新增 OpenAPI

看变更集