DescribeParameterTemplates - PolarDB - Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeParameterTemplates	The operation that you want to perform. Set the value to DescribeParameterTemplates.
RegionId	String	Yes	cn-hangzhou	The region ID of the instance.
DBInstanceId	String	Yes	pxc-********	The ID of the instance.
ParamLevel	String	No	compute	The parameter level. Valid values: compute: the computing layer storage: the storage layer

Response parameters


Parameter	Type	Example	Description
RequestId	String	C458B1E8-1683-3645-B154-6BA32080EEA	The ID of the request.
Data	Object		The returned data.
Engine	String	polarx	The engine that is used by the instance. Default value: polarx.
EngineVersion	String	2.0	The version of the engine that is used by the instance. Default value: 2.0.
ParameterCount	Integer	218	The number of parameters in the parameter template.
Parameters	Array of TemplateRecord		The details about the parameters in the parameter template.
CheckingCode	String	[0\|1]	The valid values of the parameter.
ParameterName	String	loose_enable_gts	The name of the parameter.
Dynamic	Integer	0	Indicates whether the parameter is a dynamic parameter. Valid values: 0: The parameter is not a dynamic parameter. 1: The parameter is a dynamic parameter.
ParameterValue	String	1	The value of the parameter.
ParameterDescription	String	polarx hatp addition param	The description of the parameter.
Revisable	Integer	0	Indicates whether the parameter can be modified. Valid values: 0: The parameter cannot be modified. 1: The parameter can be modified.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeParameterTemplates
&RegionId=cn-hangzhou
&DBInstanceId=pxc-********
&ParamLevel=compute
&<Common request parameters>

Sample success responses

XML format

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 format

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
    } ]
  }
}

Error codes


HttpCode	Error code	Error message	Description
404	InvalidDBInstance.NotFound	The specified DB instance does not exist.	The error message returned because the specified PolarDB-X instance does not exist.

For a list of error codes, visit the API Error Center.