All Products
Search
Document Center

ApsaraDB RDS:DescribeParameterTemplates

Last Updated:Nov 07, 2024

Queries parameter templates.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server
  • MariaDB

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
rds:DescribeParameterTemplatesget
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}
    none
none

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
Parametersarray<object>

The details of the parameters.

TemplateRecordobject
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.
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
400Order.NoRealNameAuthenticationYou 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 cost and cost for real-name authentication.
400InsufficientAvailableQuotaYour 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.
400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
400RegionDissolvedEOMDear 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.
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.Hello customer, this area has been abolished.
400RegionEndTimeDissolvedAustraliaCloud 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.
400Price.CommoditySysCommodity system call exception.Commodity system call exception.
400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
400pay.noCreditCardAccount not bound to credit card.-
400Order.InstHasUnpaidOrderThere 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.
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.-
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
400ContainForbiddenLabelErrorThere 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.
403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.

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

Change history

Change timeSummary of changesOperation
2023-11-17The Error code has changedView Change Details