Queries the database parameter template of an ApsaraDB for RDS instance.

Before you call this operation, make sure that the instance is running one of the following database engine versions:

  • MySQL 5.5, 5.6, 5.7, and 8.0
  • SQL Server 2008 R2
  • PostgreSQL 9.4, 10, 11, and 12
  • PPAS 9.3 and 10.0
  • MariaDB 10.3

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.

DBInstanceId String Yes rm-uf6wjk5xxxxxxxxxx

The ID of the instance.

Engine String Yes mysql

The database engine that the instance is running. Valid values:

  • mysql: The instance is running MySQL.
  • mssql: The instance is running SQL Server.
  • PostgreSQL: The instance is running PostgreSQL.
  • PPAS: The instance is running PPAS.
  • MariaDB: The instance is running MariaDB.
EngineVersion String Yes 5.6

The database engine version that the instance is running. Valid values:

  • MySQL: 5.5 | 5.6 | 5.7 | 8.0
  • SQL Server: 2008r2
  • PostgreSQL: 9.4 | 10.0 | 11.0 | 12.0
  • PPAS: 9.3 | 10.0
  • MariaDB: 10.3
ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxx

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.

Category String No Basic

The RDS edition of the instance. Valid values:

  • Basic: The instance is running the Basic Edition.
  • HighAvailability: The instance is running the High-availability Edition.
  • Finance: The instance is running the Enterprise Edition.

RegionId String No cn-hangzhou

The ID of the region to which the instance belongs. You can call the DescribeRegions operation to query the most recent region list.

Response parameters

Parameter Type Example Description
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

Engine String MySQL

The database engine that the RDS instance is running.

EngineVersion String 5.5

The database engine version that the instance is running.

ParameterCount String 56

The number of parameters in the parameter template.

Parameters Array

An array that consists of parameters.

ParameterName String auto_increment_increment

The name of the parameter.

ParameterValue String 1

The default value of the parameter.

ForceModify String true

Indicates whether the parameter can be reconfigured. Valid values: true | false.

ForceRestart String false

Indicates whether the new value of the parameter takes effect only after an instance restart. Valid values: true | false.

CheckingCode String [10-3000]

The valid values of the parameter.

ParameterDescription String determines the starting point for the AUTO_INCREMENT column value.

The description of the parameter.

Examples

Sample requests

http(s)://rds.aliyuncs.com/? Action=DescribeParameterTemplates
&Engine=MySQL
&EngineVersion=5.6
&<Common request parameters>

Sample success responses

XML format

<DescribeParameterTemplatesResponse>
    <Engine>mssql</Engine>
    <EngineVersion>2008r2</EngineVersion>
    <ParameterCount>1</ParameterCount>
    <Parameters>
        <TemplateRecord>
          <CheckingCode>[0-100]</CheckingCode>
          <ForceRestart>True</ForceRestart>
          <Factor>1</Factor>
          <ParameterDescription> xxxxxxx </ParameterDescription>
          <ParameterName>fill factor</ParameterName>
          <ParameterValue>0</ParameterValue>
          <ForceModify>True</ForceModify>
          <Unit>INT</Unit>
        </TemplateRecord>
    </Parameters>
    <RequestId>7B96585A-0FF2-4979-8FE5-7D147A29FDC0</RequestId>
</DescribeParameterTemplatesResponse>

JSON format

{
  "DescribeParameterTemplatesResponse": {
    "Engine": "mssql",
    "EngineVersion": "2008r2",
    "ParameterCount": "1",
    "Parameters": {
      "TemplateRecord": {
        "CheckingCode": "[0-100]",
        "ForceRestart": "True",
        "Factor": "1",
        "ParameterDescription": " xxxxxxx",
        "ParameterName": "fill factor",
        "ParameterValue": "0",
        "ForceModify": "True",
        "Unit": "INT"
      }
    },
    "RequestId": "7B96585A-0FF2-4979-8FE5-7D147A29FDC0"
  }
}

Error codes

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