DescribeDBClusterParameters - 查看PolarDB集群当前参数运行列表 - 云原生数据库 PolarDB

查看PolarDB集群当前参数运行列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
polardb:DescribeDBClusterParameters	Read	dbcluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。	pc-**********
DescribeType	string	否	内核参数，取值范围如下： Normal：内核参数列表。 MigrationFromRDS：RDS 参数比对。	Normal

返回参数

名称	类型	描述	示例值
	object
RunningParameters	object []	PolarDB 集群中当前运行的参数列表。
CheckingCode	string	目标参数的取值范围。	[utf8\|latin1\|gbk\|utf8mb4]
DataType	string	参数值类型。取值范围如下： INT：整数类型。 STRING：字符串类型。 B：字节类型。	INT
ParameterName	string	参数名。	character_set_server
ParameterValue	string	参数值。	utf8
ForceRestart	boolean	是否需要重启生效。取值范围如下： false：否。 true：是。	true
ParameterDescription	string	参数描述。	The server's default character set.
ParameterStatus	string	参数状态。取值范围如下： Normal：正常。 Modifying：修改中。	Normal
DefaultParameterValue	string	参数默认值。	utf8
IsModifiable	boolean	是否可修改。取值范围如下： false：不可修改。 true：可修改。	true
IsNodeAvailable	string	是否是全局参数。取值范围如下： 0：是全局参数。修改后的参数值会默认同步到其它节点； 1：不是全局参数。修改后的参数值可自定义需要同步的节点。	0
ParamRelyRule	string	参数依赖。	utf8
Factor	string	整除因子。对于整数和字节类型的参数，参数值除了必须满足参数的可选范围，还须是 Factor（不等于 0）的倍数。	20
DBVersion	string	数据库引擎版本号。 MySQL 版本号取值范围如下： 5.6 5.7 8.0 PostgreSQL 版本号取值范围如下： 11 14 Oracle 版本号取值范围如下： 11 14	5.6
RequestId	string	请求 ID。	EBEAA83D-1734-42E3-85E3-E25F6E******
DBType	string	数据库类型，取值范围如下： MySQL。 PostgreSQL。 Oracle。	MySQL
Engine	string	引擎。	POLARDB
DBClusterId	string	集群 ID。	pc-bp1s826a1up******
ParameterNumbers	string	参数个数。	1
Parameters	object []	RDS 实例迁移 PolarDB 集群中当前运行的参数比对列表。
rdsParameterName	string	源实例参数名称。	character_set_server
rdsParameterValue	string	源实例参数值。	utf8
rdsParameterOptional	string	源实例参数取值范围。	- utf8 - gbk
distParameterName	string	集群参数名称。	character_set_server
distParameterValue	string	集群参数值。	utf8
distParameterOptional	string	集群参数取值范围。	- utf8 - gbk
IsEqual	string	参数取值是否相同	true
distParameterDescription	string	集群参数说明。	The server's default character set.
rdsParameterDescription	string	源实例参数说明。	The server's default character set.
IsRdsKey	string	是否是主要的源实例参数。取值范围如下： 1：是主要的源实例参数。 0：不是主要的源实例参数。	1
IsPolarDBKey	string	是否是主要的目标实例参数。 1：是主要的目标实例参数。 0：不是主要的目标实例参数。	0
IsInstancePolarDBKey	string	是否是主要的目标实例参数。 1：是主要的目标实例参数。 0：不是主要的目标实例参数。	1
IsInstanceRdsKey	string	是否是主要的源实例参数。 1：是主要的源实例参数。 0：不是主要的源实例参数。	0

示例

正常返回示例

JSON格式

{
  "RunningParameters": {
    "Parameter": [
      {
        "CheckingCode": "[utf8|latin1|gbk|utf8mb4]",
        "DataType": "INT",
        "ParameterName": "character_set_server",
        "ParameterValue": "utf8",
        "ForceRestart": true,
        "ParameterDescription": "The server's default character set.",
        "ParameterStatus": "Normal",
        "DefaultParameterValue": "utf8",
        "IsModifiable": true,
        "IsNodeAvailable": "0",
        "ParamRelyRule": "utf8",
        "Factor": "20"
      }
    ]
  },
  "DBVersion": "5.6",
  "RequestId": "EBEAA83D-1734-42E3-85E3-E25F6E******",
  "DBType": "MySQL",
  "Engine": "POLARDB",
  "DBClusterId": "pc-bp1s826a1up******\t\n",
  "ParameterNumbers": "1",
  "Parameters": {
    "Parameters": [
      {
        "rdsParameterName": "character_set_server",
        "rdsParameterValue": "utf8",
        "rdsParameterOptional": "- utf8\n- gbk",
        "distParameterName": "character_set_server",
        "distParameterValue": "utf8",
        "distParameterOptional": "- utf8\n- gbk",
        "IsEqual": "true",
        "distParameterDescription": "The server's default character set.",
        "rdsParameterDescription": "The server's default character set.",
        "IsRdsKey": "1",
        "IsPolarDBKey": "0",
        "IsInstancePolarDBKey": "1",
        "IsInstanceRdsKey": "0"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	指定的参数DBClusterId无效
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API does not support RAM.	用户无权操作指定资源，或此API不支持RAM。
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	当前的记录中不存在提供的DBClusterId。

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

变更历史

变更时间

变更内容概要

操作

2024-02-29

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

看变更集

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

2023-06-12

OpenAPI 错误码发生变更

看变更集

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

2023-06-08

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

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
入参	OpenAPI 入参发生变更。
	新增入参：DescribeType
出参	OpenAPI 返回结构发生变更。

2022-07-18

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。

2022-02-24

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。