调用DescribeDBClusterParameters接口查看PolarDB集群当前参数运行列表。

调试

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

请求参数

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

系统规定参数。取值：DescribeDBClusterParameters。

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

集群ID。

返回数据

名称 类型 示例值 描述
RunningParameters Array of Parameter

PolarDB集群中当前运行的参数列表。
Parameter
CheckingCode String [utf8|latin1|gbk|utf8mb4]

目标参数的取值范围。
DataType String INT

参数值类型。取值：

  • INT：整数类型。
  • STRING：字符串类型。
  • B：字节类型。
ParameterName String character_set_server

参数名。
ParameterValue String utf8

参数值。
ForceRestart Boolean true

是否需要重启生效。取值：

  • false：否。
  • true：是。
ParameterDescription String The server's default character set.

参数描述。
ParameterStatus String Normal

参数状态。取值：

  • Normal：正常。
  • Modifying：修改中。
DefaultParameterValue String utf8

参数默认值。
IsModifiable Boolean true

是否可修改。取值：

  • false：不可修改。
  • true：可修改。
IsNodeAvailable String 0

是否是全局参数。取值如下：

  • 0：是全局参数。修改后的参数值会默认同步到其它节点；
  • 1：不是全局参数。修改后的参数值可自定义需要同步的节点。
ParamRelyRule String utf8

参数依赖。
Factor String 20

整除因子。对于整数和字节类型的参数，参数值除了必须满足参数的可选范围，还须是Factor（不等于0）的倍数。
DBVersion String 5.6

数据库引擎版本号。

MySQL版本号取值范围如下：

  • 5.6
  • 5.7
  • 8.0

PostgreSQL版本号取值范围如下：

  • 11
  • 14

Oracle版本号取值为11。

RequestId String EBEAA83D-1734-42E3-85E3-E25F6E******

请求ID。
DBType String MySQL

数据库类型，取值：

  • MySQL。
  • PostgreSQL。
  • Oracle。
Engine String POLARDB

引擎。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeDBClusterParameters
&DBClusterId=pc-**********
&<公共请求参数>

正常返回示例

XML格式 

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

<DescribeDBClusterParametersResponse>
    <RunningParameters>
        <CheckingCode>[utf8|latin1|gbk|utf8mb4]</CheckingCode>
        <DataType>INT</DataType>
        <ParameterName>character_set_server</ParameterName>
        <ParameterValue>utf8</ParameterValue>
        <ForceRestart>true</ForceRestart>
        <ParameterDescription>The server's default character set.</ParameterDescription>
        <ParameterStatus>Normal</ParameterStatus>
        <DefaultParameterValue>utf8</DefaultParameterValue>
        <IsModifiable>true</IsModifiable>
        <IsNodeAvailable>0</IsNodeAvailable>
        <ParamRelyRule>utf8</ParamRelyRule>
        <Factor>20</Factor>
    </RunningParameters>
    <DBVersion>5.6</DBVersion>
    <RequestId>EBEAA83D-1734-42E3-85E3-E25F6E******</RequestId>
    <DBType>MySQL</DBType>
    <Engine>POLARDB</Engine>
</DescribeDBClusterParametersResponse>

JSON格式 

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

{
  "RunningParameters" : [ {
    "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"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定的参数DBClusterId无效

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