You can call this operation to view database parameter templates.

This operation is appliable to the following database engine versions:

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

Debugging

You can use OpenAPI Explorer to perform debugging. OpenAPI Explorer allows you to perform various operations to simplify API usage. For example, you can retrieve APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Parameter Type Required? Example Description
Action String Yes DescribeParameterTemplates

The operation that you want to perform. Set this parameter to DescribeParameterTemplates.

Engine String Yes MySQL

The type of the database. Valid values:

  • mysql
  • mssql
  • PostgreSQL
  • PPAS
  • MariaDB
Engineversion String Yes 5.6

The version of the database. Valid values:

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

The client token that is used to guarantee the idempotency of requests. The client token is generated by the client and is unique among different requests. It is a string of up to 64 ASCII characters.

AccessKeyId String No LTAIfCxxxxxxx

The AccessKey ID issued by Alibaba Cloud for users to access services.

Category String No basic

The type of the instance. Valid values:

  • Basic
  • HighAvailability

By default, all types of parameter templates are returned.

Response parameters

Parameter Type Example Description
Engine String MySQL

The type of the database.

Engineversion String 5.5

The version of the database.

ParameterCount String 56

The number of parameters.

Parameters N/A

The list 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 modified. Valid values: true | false.

ForceRestart String false

Indicates whether the modified parameter takes effect only after a database 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.

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

Examples

Sample requests


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

Successful response examples

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> This option sets the default fill factor value
at the server scope. A fill factor is provided to optimize index data storage
and performance. </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":{
		"Parameters":{
			"TemplateRecord":{
				"ForceModify":"True",
				"ParameterDescription":"This option sets the default fill factor value
at the server scope. A fill factor is provided to optimize index data storage
and performance.",
				"Factor":"1",
				"ParameterValue":"0",
				"ForceRestart":"True",
				"CheckingCode":"[0-100]",
				"ParameterName":"fill factor",
				"Unit":"INT"
			}
		},
		"RequestId":"7B96585A-0FF2-4979-8FE5-7D147A29FDC0",
		"ParameterCount":"1",
		"EngineVersion":"2008r2",
		"Engine":"mssql"
	}
}

Error codes

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