调用DescribeParameterTemplates接口查询集群默认的参数列表。

调试

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

请求参数

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

系统规定参数。取值:DescribeParameterTemplates

DBType String MySQL

数据库引擎类型,当前仅支持MySQL

DBVersion String 5.7

数据库版本,取值范围如下:

  • 5.6
  • 5.7
  • 8.0
RegionId String cn-hangzhou

地域ID。

说明 您可以通过DescribeRegions接口查看当前账号下的所有可用地域信息,包括地域ID。

返回数据

名称 类型 示例值 描述
ParameterCount String 183

参数数量。

DBVersion String 5.7

数据库引擎版本。

Parameters Array of TemplateRecord

参数列表。

TemplateRecord
CheckingCode String [ROW|STATEMENT|MIXED]

参数取值范围。

ParameterName String binlog_format

参数名称。

ParameterValue String ROW

参数默认值。

ForceModify String true

参数是否可修改,取值范围如下:

  • true:可修改
  • false:不可修改
ForceRestart String false

参数修改后,是否需要重启新参数值才生效。取值范围如下:

  • true:需要重启
  • false:不需要重启
ParameterDescription String What form of binary logging the master will use.

参数描述。

IsNodeAvailable String 1

是否是全局参数。取值:

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

参数依赖。

RequestId String D963934D-8605-4473-8EAC-54C719******

请求ID。

DBType String MySQL

数据库引擎类型。

Engine String POLARDB

数据库引擎。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeParameterTemplates
&DBType=MySQL
&DBVersion=5.7
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

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

<DescribeParameterTemplatesResponse>
    <ParameterCount>183</ParameterCount>
    <DBVersion>5.7</DBVersion>
    <Parameters>
        <CheckingCode>[ROW|STATEMENT|MIXED]</CheckingCode>
        <ParameterName>binlog_format</ParameterName>
        <ParameterValue>ROW</ParameterValue>
        <ForceModify>true</ForceModify>
        <ForceRestart>false</ForceRestart>
        <ParameterDescription>What form of binary logging the master will use.</ParameterDescription>
        <IsNodeAvailable>1</IsNodeAvailable>
        <ParamRelyRule>utf8</ParamRelyRule>
    </Parameters>
    <RequestId>D963934D-8605-4473-8EAC-54C719******</RequestId>
    <DBType>MySQL</DBType>
    <Engine>POLARDB</Engine>
</DescribeParameterTemplatesResponse>

JSON格式

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

{
  "ParameterCount" : "183",
  "DBVersion" : "5.7",
  "Parameters" : [ {
    "CheckingCode" : "[ROW|STATEMENT|MIXED]",
    "ParameterName" : "binlog_format",
    "ParameterValue" : "ROW",
    "ForceModify" : "true",
    "ForceRestart" : "false",
    "ParameterDescription" : "What form of binary logging the master will use.",
    "IsNodeAvailable" : "1",
    "ParamRelyRule" : "utf8"
  } ],
  "RequestId" : "D963934D-8605-4473-8EAC-54C719******",
  "DBType" : "MySQL",
  "Engine" : "POLARDB"
}

错误码

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