Queries parameter templates of a specified PolarDB cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeParameterTemplates

The operation that you want to perform. Set the value to DescribeParameterTemplates.

DBType String Yes MySQL

The type of the database engine. Only MySQL is supported.

DBVersion String Yes 5.7

The version of the database. Valid values:

  • 5.6
  • 5.7
  • 8.0
RegionId String Yes cn-hangzhou

The region ID of the cluster.

Note You can call the DescribeRegions operation to query all regions that are available within your account, such as the region ID.

Response parameters

Parameter Type Example Description
ParameterCount String 183

The number of parameters in the parameter template.

DBVersion String 5.7

The version of the database engine.

Parameters Array of TemplateRecord

Details about parameters.

TemplateRecord
CheckingCode String [ROW|STATEMENT|MIXED]

The valid values of the parameter.

ParameterName String binlog_format

The name of the parameter.

ParameterValue String ROW

The default value of the parameter.

ForceModify String true

Indicates whether the parameter setting can be modified. Valid values:

  • true
  • false
ForceRestart String false

Indicates whether a cluster restart is required to make the parameter modification take effect. Valid values:

  • true
  • false
ParameterDescription String What form of binary logging the master will use.

The description of the parameter.

IsNodeAvailable String 1

Indicates whether the parameter is a global parameter. Valid values:

  • 0: yes. The modified parameter value is synchronized to other nodes by default.
  • 1: no. You can customize the nodes the modified parameter value can be synchronized to.
ParamRelyRule String utf8

The parameter dependencies.

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

The ID of the request.

DBType String MySQL

The type of the database engine.

Engine String POLARDB

The database engine that the cluster runs.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=DescribeParameterTemplates
&DBType=MySQL
&DBVersion=5.7
&RegionId=cn-hangzhou
&Common request parameters

Sample success responses

XML format 

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 format 

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

Error codes

For a list of error codes, visit the API Error Center.