DescribeParameterTemplates - PolarDB - Alibaba Cloud Documentation Center

Calls the DescribeParameterTemplates operation to retrieve the parameter template list of an instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardbx:DescribeParameterTemplates

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
ParamLevel	string	No	The parameter level. Valid values: compute: compute layer. storage: storage layer.	compute
EngineVersion	string	No
DBInstanceId	string	Yes	The instance ID.	pxc-********

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	C458B1E8-1683-3645-B154-6BA32080EEA
Data	object	The data struct.
Engine	string	The engine. Default value: polarx.	polarx
EngineVersion	string	The DPI engine version. Default value: 2.0.	2.0
ParameterCount	integer	The number of parameters.	218
Parameters	array<object>	The parameter list.
	object
CheckingCode	string	The validation constraint.	[0\|1]
ParameterName	string	The parameter name.	loose_enable_gts
Dynamic	integer	Indicates whether the parameter is dynamic. Valid values: 0: No. 1: Yes.	0
ParameterValue	string	The parameter value.	1
ParameterDescription	string	The parameter description.	polarx hatp addition param
Revisable	integer	Indicates whether the parameter can be modified. Valid values: 0: The parameter cannot be modified. 1: The parameter can be modified.	0
UserChangable	integer		0

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBInstance.NotFound	The specified DB instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.