使用DescribeParameterTemplates查询参数模板列表-云原生数据库 PolarDB-阿里云

查询数据库集群默认参数的列表。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeParameterTemplates

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*

无

请求参数

名称	类型	必填	描述	示例值
DBType	string	是	数据库引擎类型，当前仅支持 MySQL。	MySQL
DBVersion	string	是	数据库版本，取值范围如下： 5.6 5.7 8.0	5.7
RegionId	string	是	地域 ID。说明您可以通过 DescribeRegions 接口查看当前账号下的所有可用地域信息，包括地域 ID。	cn-hangzhou
ResourceGroupId	string	否	资源组 ID。	rg-************

返回参数

名称	类型	描述	示例值
	object
ParameterCount	string	参数数量。	183
DBVersion	string	数据库引擎版本。	5.7
Parameters	object
TemplateRecord	array<object>	参数列表。
	object
CheckingCode	string	参数取值范围。	[ROW\|STATEMENT\|MIXED]
ParameterName	string	参数名称。	binlog_format
ParameterValue	string	参数默认值。	ROW
ForceModify	string	参数是否可修改，取值范围如下： true：可修改 false：不可修改	true
ForceRestart	string	参数修改后，是否需要重启新参数值才生效。取值范围如下： true：需要重启 false：不需要重启	false
ParameterDescription	string	参数描述。	What form of binary logging the master will use.
IsNodeAvailable	string	是否是全局参数。取值： 0：是全局参数。修改后的参数值会默认同步到其他节点； 1：不是全局参数。修改后的参数值可自定义需要同步的节点。	1
ParamRelyRule	string	参数依赖。	utf8
RequestId	string	请求 ID。	D963934D-8605-4473-8EAC-54C719******
DBType	string	数据库引擎类型。	MySQL
Engine	string	数据库引擎。	POLARDB

示例

正常返回示例

JSON格式

{
  "ParameterCount": "183",
  "DBVersion": "5.7",
  "Parameters": {
    "TemplateRecord": [
      {
        "CheckingCode": "[ROW|STATEMENT|MIXED]",
        "ParameterName": "binlog_format",
        "ParameterValue": "ROW",
        "ForceModify": "true",
        "ForceRestart": "false",
        "ParameterDescription": "What form of binary logging the master will use.",
        "IsNodeAvailable": "1",
        "ParamRelyRule": "utf8"
      }
    ]
  },
  "RequestId": "D963934D-8605-4473-8EAC-54C719******",
  "DBType": "MySQL",
  "Engine": "POLARDB"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidDBType.NotFound	The Specified DBType does not found.
400	InvalidDBVersion.Malformed	The Specified DBVersion is not valid.	指定的DBVersion无效

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

变更历史

更多信息，参考变更详情。