All Products
Search
Document Center

ApsaraDB RDS:DescribeParameterTemplates

Last Updated:Apr 18, 2024

Queries parameter templates.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server
  • MariaDB

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

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

ETnLKlblzczshOTUbOCzxxxxxxx
EnginestringYes

The database engine of the instance. Valid values:

  • mysql: MySQL
  • mssql: SQL Server
  • PostgreSQL: PostgreSQL
  • MariaDB: MariaDB
mysql
EngineVersionstringYes

The version of the database engine. Valid values:

  • Valid values when you set the Engine parameter to mysql: 5.5, 5.6, 5.7, and 8.0.
  • Valid values when you set the Engine parameter to mssql: 2008r2.
  • Valid values when you set the Engine parameter to PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, and 15.0.
  • Valid values when you set the Engine parameter to MariaDB: 10.3.
8.0
CategorystringNo

The RDS edition of the instance. Valid values:

  • Basic: RDS Basic Edition
  • HighAvailability: RDS High-availability Edition
  • Finance: RDS Enterprise Edition
Basic
RegionIdstringNo

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
DBInstanceIdstringYes

The instance ID.

rm-bp1imnm**********

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

0F9B7410-EC73-510C-B385-8339455C12C6
Enginestring

The database engine of the instance.

mysql
ParameterCountstring

The number of parameters.

2
EngineVersionstring

The version of the database engine.

8.0
Parametersobject []

The details of the parameters.

CheckingCodestring

The valid values of the parameter.

[0-1024]
ParameterNamestring

The name of the parameter.

loose_multi_blocks_ddl_count
ParameterValuestring

The default value of the parameter.

0
ForceModifystring

Indicates whether the parameter can be modified. Valid values:

  • true
  • false
true
ForceRestartstring

Indicates whether you must restart the instance for the modifications to take effect. Valid values:

  • true
  • false
false
ParameterDescriptionstring

The description of the parameter.

Page numbers of multi blocks reading once in some ddl query.

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400Invalid.ParamGroupDBCategoryInvalid parameter group categoryThe operation failed. The categories of parameter groups are invalid
400ParameterIllegalParam is illegal parameter.The request parameter is invalid. Check the parameter.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-11-17The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change