All Products
Search
Document Center

PolarDB:DescribeParameterGroups

Last Updated:Mar 01, 2024

Queries parameter templates that are available in a specified region.

Operation description

You can use parameter templates to manage multiple parameters at a time and apply existing parameters to a PolarDB cluster. For more information, see Use a parameter template.

Note This operation is applicable only to PolarDB for MySQL clusters.

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:DescribeParameterGroupsList
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the cluster.

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

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

MySQL
DBVersionstringNo

The version of the database engine. Valid values:

  • 5.6
  • 5.7
  • 8.0
8.0
ResourceGroupIdstringNo

The ID of the resource group to which the virtual node belongs.

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

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

944CED46-A6F7-40C6-B6DC-C6E5CC******
ParameterGroupsobject []

The details of parameter templates.

DBTypestring

The type of the engine.

MySQL
DBVersionstring

The version of the database engine

8.0
ParameterGroupNamestring

The name of the parameter template.

test
ForceRestartstring

Indicates whether to restart the cluster when this parameter template is applied. Valid values:

  • 0: A restart is not required.
  • 1: A restart is required.
1
ParameterGroupTypestring

The type of the parameter template. Valid values:

  • 0: the default parameter template.
  • 1: a custom parameter template.
  • 2: an automatic backup parameter template. After you apply this type of template, the system automatically backs up the original parameter settings and saves the backup as a template.
1
ParameterCountslong

The number of parameters in the parameter template.

2
ParameterGroupDescstring

The description of the parameter template.

testgroup
CreateTimestring

The time when the parameter template was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2023-03-10T08:40:39Z
ParameterGroupIdstring

The ID of the parameter template.

pcpg-**************

Examples

Sample success responses

JSONformat

{
  "RequestId": "944CED46-A6F7-40C6-B6DC-C6E5CC******",
  "ParameterGroups": [
    {
      "DBType": "MySQL",
      "DBVersion": "8.0",
      "ParameterGroupName": "test",
      "ForceRestart": "1",
      "ParameterGroupType": "1",
      "ParameterCounts": 2,
      "ParameterGroupDesc": "testgroup",
      "CreateTime": "2023-03-10T08:40:39Z",
      "ParameterGroupId": "pcpg-**************"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidRegionId.MalformedThe specified parameter RegionId is not valid.The specified RegionId parameter is invalid.
400InvalidEngine.UnsupportedThe specified Engine does not support this feature.This feature is not supported by the specified engine.

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

Change history

Change timeSummary of changesOperation
2023-09-12The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change