DescribeParameterTemplates - 查看参数模版详情 - 云原生数据库 PolarDB

调用DescribeParameterTemplates接口获取实例参数模版列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:DescribeParameterTemplates

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	实例所属地域 ID。	cn-hangzhou
ParamLevel	string	否	参数级别，取值如下： compute：计算层； storage：存储层。	compute
EngineVersion	string	否
DBInstanceId	string	是	实例 ID。	pxc-********

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	C458B1E8-1683-3645-B154-6BA32080EEA
Data	object	数据结构体。
Engine	string	引擎，默认 polarx。	polarx
EngineVersion	string	引擎版本，默认 2.0。	2.0
ParameterCount	integer	参数个数。	218
Parameters	array<object>	参数列表。
	object
CheckingCode	string	检测约制。	[0\|1]
ParameterName	string	参数名。	loose_enable_gts
Dynamic	integer	是否动态： 0：否； 1：是。	0
ParameterValue	string	参数值。	1
ParameterDescription	string	参数描述。	polarx hatp addition param
Revisable	integer	是否可以修改 0：不能修改； 1：修改。	0
UserChangable	integer	用户可以修改	0

示例

正常返回示例

JSON格式

{
  "RequestId": "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Data": {
    "Engine": "polarx",
    "EngineVersion": "2.0",
    "ParameterCount": 218,
    "Parameters": [
      {
        "CheckingCode": "[0|1]",
        "ParameterName": "loose_enable_gts",
        "Dynamic": 0,
        "ParameterValue": "1",
        "ParameterDescription": "polarx hatp addition param",
        "Revisable": 0,
        "UserChangable": 0
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBInstance.NotFound	The specified DB instance does not exist.	数据库实例不存在

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

变更历史

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