调用DescribeDBClusterParameters接口查看PolarDB集群的参数。

调试

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

请求参数

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

系统规定参数。取值:DescribeDBClusterParameters

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

集群ID。

返回数据

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

当前运行的参数列表。

Parameter
CheckingCode String [utf8|latin1|gbk|utf8mb4]

目标参数的取值范围。

DataType String INT

参数值类型。

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 1

子节点是否可用

ParamRelyRule String 1

副热带

DBVersion String 5.6

数据库引擎版本号。

  • MySQL版本号取值范围如下:
    • 5.6
    • 5.7
    • 8.0
  • PostgreSQL版本号取值为11
  • 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>
    <Parameter>
        <ParameterStatus>Normal</ParameterStatus>
        <DefaultParameterValue>1</DefaultParameterValue>
        <IsModifiable>true</IsModifiable>
        <DataType>INT</DataType>
        <ParameterDescription>Auto-increment columns are incremented by this</ParameterDescription>
        <ParameterValue>1</ParameterValue>
        <CheckingCode>[1-65535]</CheckingCode>
        <ForceRestart>false</ForceRestart>
        <ParameterName>auto_increment_increment</ParameterName>
    </Parameter>
    <Parameter>
        <DefaultParameterValue>utf8</DefaultParameterValue>
        <IsModifiable>true</IsModifiable>
        <CheckingCode>[utf8|latin1|gbk|utf8mb4]</CheckingCode>
        <ParameterValue>utf8</ParameterValue>
        <ParameterStatus>Normal</ParameterStatus>
        <ForceRestart>true</ForceRestart>
        <DataType>STRING</DataType>
        <ParameterName>character_set_server</ParameterName>
        <ParameterDescription>The server's default character set.</ParameterDescription>
    </Parameter>
</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" : {
    "Parameter" : [ {
      "ParameterStatus" : "Normal",
      "DefaultParameterValue" : 1,
      "IsModifiable" : true,
      "DataType" : "INT",
      "ParameterDescription" : "Auto-increment columns are incremented by this",
      "ParameterValue" : 1,
      "CheckingCode" : "[1-65535]",
      "ForceRestart" : false,
      "ParameterName" : "auto_increment_increment"
    }, {
      "DefaultParameterValue" : "utf8",
      "IsModifiable" : true,
      "CheckingCode" : "[utf8|latin1|gbk|utf8mb4]",
      "ParameterValue" : "utf8",
      "ParameterStatus" : "Normal",
      "ForceRestart" : true,
      "DataType" : "STRING",
      "ParameterName" : "character_set_server",
      "ParameterDescription" : "The server's default character set."
    } ]
  },
  "DBVersion" : "5.6",
  "RequestId" : "EBEAA83D-1734-42E3-85E3-E25F6E******",
  "DBType" : "MySQL",
  "Engine" : "POLARDB"
}

错误码

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