DescribeParameterTemplates - ApsaraDB RDS - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	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
Engine	string	Yes	The database engine of the instance. Valid values: mysql: MySQL mssql: SQL Server PostgreSQL: PostgreSQL MariaDB: MariaDB	mysql
EngineVersion	string	Yes	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
Category	string	No	The RDS edition of the instance. Valid values: Basic: RDS Basic Edition HighAvailability: RDS High-availability Edition Finance: RDS Enterprise Edition	Basic
RegionId	string	No	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBInstanceId	string	Yes	The instance ID.	rm-bp1imnm**********

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0F9B7410-EC73-510C-B385-8339455C12C6
Engine	string	The database engine of the instance.	mysql
ParameterCount	string	The number of parameters.	2
EngineVersion	string	The version of the database engine.	8.0
Parameters	array<object>	The details of the parameters.
	object
CheckingCode	string	The valid values of the parameter.	[0-1024]
ParameterName	string	The name of the parameter.	loose_multi_blocks_ddl_count
ParameterValue	string	The default value of the parameter.	0
ForceModify	string	Indicates whether the parameter can be modified. Valid values: true false	true
ForceRestart	string	Indicates whether you must restart the instance for the modifications to take effect. Valid values: true false	false
ParameterDescription	string	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

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

Change history

Change time	Summary of changes	Operation
2023-11-17	The Error code has changed	View Change Details

HTTP status code	Error code	Error message	Description
400	Invalid.ParamGroupDBCategory	Invalid parameter group category	The operation failed. The categories of parameter groups are invalid
400	ParameterIllegal	Param is illegal parameter.	The request parameter is invalid. Check the parameter.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account available limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedIndia	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.	-
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	-
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	BasicInfoUncompleted	Your information is incomplete, Complete your information before the operation.	-
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.