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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeParameterTemplates

系统规定参数。取值:DescribeParameterTemplates

RegionId String cn-hangzhou

实例所属地域ID。

DBInstanceId String pxc-********

实例ID。

ParamLevel String compute

参数级别,取值如下:

  • compute:计算层;
  • storage:存储层。

返回数据

名称 类型 示例值 描述
RequestId String C458B1E8-1683-3645-B154-6BA32080EEA

请求ID。

Data Object

数据结构体。

Engine String polarx

引擎,默认polarx。

EngineVersion String 2.0

引擎版本,默认2.0。

ParameterCount Integer 218

参数个数。

Parameters Array of TemplateRecord

参数列表。

CheckingCode String [0|1]

检测约制。

ParameterName String loose_enable_gts

参数名。

Dynamic Integer 0

是否动态:

  • 0:否;
  • 1:是。
ParameterValue String 1

参数值。

ParameterDescription String polarx hatp addition param

参数描述。

Revisable Integer 0

是否可以修改

  • 0:不能修改;
  • 1:修改。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeParameterTemplates
&RegionId=cn-hangzhou
&DBInstanceId=pxc-********
&ParamLevel=compute
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeParameterTemplatesResponse>
    <RequestId>C458B1E8-1683-3645-B154-6BA32080EEA</RequestId>
    <Data>
        <Engine>polarx</Engine>
        <EngineVersion>2.0</EngineVersion>
        <ParameterCount>218</ParameterCount>
        <Parameters>
            <CheckingCode>[0|1]</CheckingCode>
            <ParameterName>loose_enable_gts</ParameterName>
            <Dynamic>0</Dynamic>
            <ParameterValue>1</ParameterValue>
            <ParameterDescription>polarx hatp addition param</ParameterDescription>
            <Revisable>0</Revisable>
        </Parameters>
    </Data>
</DescribeParameterTemplatesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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
    } ]
  }
}

错误码

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

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