DescribeParameterTemplates - PolarDB - Alibaba Cloud Documentation Center

Queries the default parameters of a database cluster.

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

polardb:DescribeParameterTemplates

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*

None

Request parameters

Parameter	Type	Required	Description	Example
DBType	string	Yes	The database engine type. Only MySQL is supported.	MySQL
DBVersion	string	Yes	The database version. Valid values: 5.6 5.7 8.0	5.7
RegionId	string	Yes	The region ID. Note Call the DescribeRegions operation to query the IDs of available regions.	cn-hangzhou
ResourceGroupId	string	No	The resource group ID.	rg-************

Response elements

Element	Type	Description	Example
	object
ParameterCount	string	The number of parameters.	183
DBVersion	string	The database engine version.	5.7
Parameters	object
TemplateRecord	array<object>	A list of parameters.
	object
CheckingCode	string	The valid values for the parameter.	[ROW\|STATEMENT\|MIXED]
ParameterName	string	The parameter name.	binlog_format
ParameterValue	string	The default value of the parameter.	ROW
ForceModify	string	Indicates whether the parameter can be modified. Valid values: true: The parameter can be modified. false: The parameter cannot be modified.	true
ForceRestart	string	Indicates whether a restart is required for a new parameter value to take effect. Valid values: true: A restart is required. false: A restart is not required.	false
ParameterDescription	string	The parameter description.	What form of binary logging the master will use.
IsNodeAvailable	string	Indicates whether the parameter is a global parameter. Valid values: 0: The parameter is a global parameter. The modified parameter value is synchronized to other nodes by default. 1: The parameter is not a global parameter. You can specify the nodes to which the modified parameter value is synchronized.	1
ParamRelyRule	string	The parameter dependencies.	utf8
RequestId	string	The request ID.	D963934D-8605-4473-8EAC-54C719******
DBType	string	The database engine type.	MySQL
Engine	string	The database engine.	POLARDB

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBType.NotFound	The Specified DBType does not found.
400	InvalidDBVersion.Malformed	The Specified DBVersion is not valid.	The specified DBVersion parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.