DescribeParameterTemplates - 查看参数模版详情列表_关系型数据库-阿里云帮助中心

调用DescribeParameterTemplates接口查询数据库参数模板。

接口说明

该接口适用的实例版本如下：

MySQL 5.5、5.6、5.7、8.0
SQL Server 2008 R2
PostgreSQL 10、11、12、13、14、15
MariaDB 10.3

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。	ETnLKlblzczshOTUbOCz****
Engine	string	是	数据库类型，取值： mysql：MySQL数据库 mssql：SQL Server数据库 PostgreSQL：PostgreSQL数据库 MariaDB：MariaDB数据库	mysql
EngineVersion	string	是	数据库版本号，取值： MySQL数据库：5.5、5.6、5.7、8.0 SQL Server数据库：2008r2 PostgreSQL数据库：10.0、11.0、12.0、13.0、14.0、15.0 MariaDB数据库：10.3	8.0
Category	string	否	实例系列，取值： Basic：基础版 HighAvailability：高可用版 Finance：三节点企业版	Basic
RegionId	string	否	地域ID。可以通过接口DescribeRegions查看可用的地域ID。	cn-hangzhou
DBInstanceId	string	是	实例ID。	rm-bp1imnm****

返回参数

名称	类型	描述	示例值
	object	返回参数详情如下。
RequestId	string	请求ID。	0F9B7410-EC73-510C-B385-8339455C12C6
Engine	string	数据库类型。	mysql
ParameterCount	string	参数个数。	2
EngineVersion	string	数据库版本号。	8.0
Parameters	array	参数列表。
	object	返回参数详情如下。
CheckingCode	string	参数取值范围。	[0-1024]
ParameterName	string	参数名。	loose_multi_blocks_ddl_count
ParameterValue	string	参数默认值。	0
ForceModify	string	参数是否可修改，返回值： true：是。 false：否。	true
ForceRestart	string	是否重启才生效，返回值： true：是。 false：否。	false
ParameterDescription	string	参数描述。	Page numbers of multi blocks reading once in some ddl query.

示例

正常返回示例

JSON格式

{
  "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."
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Invalid.ParamGroupDBCategory	Invalid parameter group category	操作失败，无效参数组类别。

访问错误中心查看更多错误码。