All Products
Search
Document Center

PolarDB:DescribeParameterTemplates

Last Updated:Mar 21, 2024

Queries the default parameters in a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:DescribeParameterTemplatesRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBTypestringYes

The type of the database engine. Only MySQL is supported.

MySQL
DBVersionstringYes

The version of the database. Valid values:

  • 5.6
  • 5.7
  • 8.0
5.7
RegionIdstringYes

The region ID.

Note You can call the DescribeRegions operation to query all regions that are available within your account, such as the region IDs.
cn-hangzhou
ResourceGroupIdstringNo

The ID of the resource group.

rg-************

Response parameters

ParameterTypeDescriptionExample
object
ParameterCountstring

The number of parameters.

183
DBVersionstring

The version of the database engine.

5.7
Parametersobject []

The details of the parameters.

CheckingCodestring

The valid values of the parameter.

[ROW|STATEMENT|MIXED]
ParameterNamestring

The name of the parameter.

binlog_format
ParameterValuestring

The default value of the parameter.

ROW
ForceModifystring

Indicates whether the parameter setting can be modified. Valid values:

  • true
  • false
true
ForceRestartstring

Indicates whether a cluster restart is required to make the parameter modification take effect. Valid values:

  • true
  • false
false
ParameterDescriptionstring

The description of the parameter.

What form of binary logging the master will use.
IsNodeAvailablestring

Indicates whether the parameter is a global parameter. Valid values:

  • 0: yes. The modified parameter value is synchronized to other nodes by default.
  • 1: no. You can customize the nodes to which the modified parameter value can be synchronized.
1
ParamRelyRulestring

The parameter dependencies.

utf8
RequestIdstring

The request ID.

D963934D-8605-4473-8EAC-54C719******
DBTypestring

The type of the database engine.

MySQL
Enginestring

The database engine of the cluster.

POLARDB

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidDBType.NotFoundThe Specified DBType does not found.The specified DBType parameter does not exist.
400InvalidDBVersion.MalformedThe Specified DBVersion is not valid.The specified DBVersion parameter is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-02-24The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.