文档

DescribeParameterTemplates - 查询参数模版列表

更新时间:

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
polardb:DescribeParameterTemplatesRead
  • DBCluster
    acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*

请求参数

名称类型必填描述示例值
DBTypestring

数据库引擎类型,当前仅支持MySQL

MySQL
DBVersionstring

数据库版本,取值范围如下:

  • 5.6
  • 5.7
  • 8.0
5.7
RegionIdstring

地域ID。

说明 您可以通过DescribeRegions接口查看当前账号下的所有可用地域信息,包括地域ID。
cn-hangzhou
ResourceGroupIdstring

资源组ID。

rg-************

返回参数

名称类型描述示例值
object
ParameterCountstring

参数数量。

183
DBVersionstring

数据库引擎版本。

5.7
Parametersobject []

参数列表。

CheckingCodestring

参数取值范围。

[ROW|STATEMENT|MIXED]
ParameterNamestring

参数名称。

binlog_format
ParameterValuestring

参数默认值。

ROW
ForceModifystring

参数是否可修改,取值范围如下:

  • true:可修改
  • false:不可修改
true
ForceRestartstring

参数修改后,是否需要重启新参数值才生效。取值范围如下:

  • true:需要重启
  • false:不需要重启
false
ParameterDescriptionstring

参数描述。

What form of binary logging the master will use.
IsNodeAvailablestring

是否是全局参数。取值:

  • 0:是全局参数。修改后的参数值会默认同步到其他节点;

  • 1:不是全局参数。修改后的参数值可自定义需要同步的节点。

1
ParamRelyRulestring

参数依赖。

utf8
RequestIdstring

请求ID。

D963934D-8605-4473-8EAC-54C719******
DBTypestring

数据库引擎类型。

MySQL
Enginestring

数据库引擎。

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错误码错误信息描述
400InvalidDBType.NotFoundThe Specified DBType does not found.找不到指定的DBType。
400InvalidDBVersion.MalformedThe Specified DBVersion is not valid.指定的DBVersion无效

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

变更历史

变更时间变更内容概要操作
2022-02-24OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈