调用DescribeParameterTemplates接口查询参数取值范围及默认值。

该接口适用的实例版本如下:

  • MySQL 5.5、5.6、5.7、8.0
  • SQL Server 2008 R2
  • PostgreSQL 10、11、12、13、14、15
  • MariaDB 10.3

调试

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

请求参数

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

系统规定参数。取值:DescribeParameterTemplates

ClientToken String ETnLKlblzczshOTUbOCz****

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。

Engine String mysql

数据库类型,取值:

  • mysql:MySQL数据库
  • mssql:SQL Server数据库
  • PostgreSQL:PostgreSQL数据库
  • MariaDB:MariaDB数据库
EngineVersion String 8.0

数据库版本号,取值:

  • MySQL数据库:5.5、5.6、5.7、8.0
  • SQL Server数据库:2008r2
  • PostgreSQL数据库:10.0、11.0、12.0、13.0、14.0、15.0
  • MariaDB数据库:10.3
Category String Basic

实例系列,取值:

  • Basic:基础版
  • HighAvailability:高可用版
  • Finance:三节点企业版
RegionId String cn-hangzhou

地域ID。可以通过接口DescribeRegions查看可用的地域ID。

DBInstanceId String rm-bp1imnm****

实例ID。

返回数据

名称 类型 示例值 描述
RequestId String 0F9B7410-EC73-510C-B385-8339455C12C6

请求ID。

Engine String mysql

数据库类型。

ParameterCount String 2

参数个数。

EngineVersion String 8.0

数据库版本号。

Parameters Array of TemplateRecord

参数列表。

TemplateRecord
CheckingCode String [0-1024]

参数取值范围。

ParameterName String loose_multi_blocks_ddl_count

参数名。

ParameterValue String 0

参数默认值。

ForceModify String true

参数是否可修改,返回值:

  • true:是。
  • false:否。
ForceRestart String false

是否重启才生效,返回值:

  • true:是。
  • false:否。
ParameterDescription String Page numbers of multi blocks reading once in some ddl query.

参数描述。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeParameterTemplates
&ClientToken=ETnLKlblzczshOTUbOCz****
&Engine=mysql
&EngineVersion=8.0
&Category=Basic
&RegionId=cn-hangzhou
&DBInstanceId=rm-bp1imnm****
&公共请求参数

正常返回示例

XML格式

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

<DescribeParameterTemplatesResponse>
    <ParameterCount>2</ParameterCount>
    <EngineVersion>8.0</EngineVersion>
    <Parameters>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>[OFF|ON]</CheckingCode>
            <ParameterValue>OFF</ParameterValue>
            <ForceRestart>false</ForceRestart>
            <ParameterName>loose_recycle_scheduler</ParameterName>
            <ParameterDescription>Switch of purge thread.</ParameterDescription>
        </TemplateRecord>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>[0-1024]</CheckingCode>
            <ParameterValue>0</ParameterValue>
            <ForceRestart>false</ForceRestart>
            <ParameterName>loose_multi_blocks_ddl_count</ParameterName>
            <ParameterDescription>Page numbers of multi blocks reading once in some ddl query.</ParameterDescription>
        </TemplateRecord>
    </Parameters>
    <RequestId>0F9B7410-EC73-510C-B385-8339455C12C6</RequestId>
    <Engine>mysql</Engine>
</DescribeParameterTemplatesResponse>

JSON格式

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

{
  "ParameterCount" : 2,
  "EngineVersion" : "8.0",
  "Parameters" : {
    "TemplateRecord" : [ {
      "ForceModify" : "true",
      "CheckingCode" : "[OFF|ON]",
      "ParameterValue" : "OFF",
      "ForceRestart" : "false",
      "ParameterName" : "loose_recycle_scheduler",
      "ParameterDescription" : "Switch of purge thread."
    }, {
      "ForceModify" : "true",
      "CheckingCode" : "[0-1024]",
      "ParameterValue" : "0",
      "ForceRestart" : "false",
      "ParameterName" : "loose_multi_blocks_ddl_count",
      "ParameterDescription" : "Page numbers of multi blocks reading once in some ddl query."
    } ]
  },
  "RequestId" : "0F9B7410-EC73-510C-B385-8339455C12C6",
  "Engine" : "mysql"
}

错误码

HttpCode 错误码 错误信息 描述
400 Invalid.ParamGroupDBCategory Invalid parameter group category 操作失败,无效参数组类别。

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