All Products
Search

This Product

    ApsaraDB RDS:DescribeParameterGroups

    Document Center

    ApsaraDB RDS:DescribeParameterGroups

    Last Updated:Sep 26, 2023

    Queries the parameter templates that are available in a region.

    Operation Description

    You can configure a number of parameters at a time by using a parameter template and then apply the parameter template to an instance. For more information, see Use a parameter template to configure the parameters of ApsaraDB RDS for MySQL instances or Use a parameter template to configure the parameters of ApsaraDB RDS for PostgreSQL instances.

    Note This operation is supported only when your instance runs MySQL or PostgreSQL.

    debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    debugging

    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
    rds:DescribeParameterGroupsREAD
    • DBInstance
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    ResourceGroupIdstringNo

    The ID of the resource group.

    		rg-acfmy****

    Response parameters

    ParameterTypeDescriptionExample
    object
    SignalForOptimizeParamsboolean

    Indicates whether parameter templates exist in the specified region. Valid values:

    • true
    • false
    		false
    RequestIdstring

    The request ID.

    		D4A23265-C5B6-42E1-98A0-EFA1EB42E723
    ParameterGroupsobject []

    The details of the parameter templates.

    UpdateTimestring

    The time when the parameter template was last updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    		2019-11-21T02:21:35Z
    ParameterGroupDescstring

    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
    CreateTimestring

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

    		2019-11-21T01:48:39Z
    ForceRestartinteger

    Indicates whether the restart of an instance is required for the parameter template to take effect. Valid values:

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

    The ID of the parameter template.

    		rpg-****
    ParameterGroupNamestring

    The name of the parameter template.

    		test1234
    Enginestring

    The database engine of the instance.

    		mysql
    ParamCountsinteger

    The number of parameters in the parameter template.

    		2
    EngineVersionstring

    The version of the database engine.

    		5.7
    ParameterGroupTypeinteger

    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

    Examples

    Sample success responses

    JSONformat

    {
  "SignalForOptimizeParams": false,
  "RequestId": "D4A23265-C5B6-42E1-98A0-EFA1EB42E723",
  "ParameterGroups": {
    "ParameterGroup": [
      {
        "UpdateTime": "2019-11-21T02:21:35Z",
        "ParameterGroupDesc": "1",
        "CreateTime": "2019-11-21T01:48:39Z",
        "ForceRestart": 1,
        "ParameterGroupId": "rpg-****",
        "ParameterGroupName": "test1234",
        "Engine": "mysql",
        "ParamCounts": 2,
        "EngineVersion": "5.7",
        "ParameterGroupType": 1
      }
    ]
  }
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2022-07-27The input parameters of the API operation change.see changesets
    Change itemChange content
    Input ParametersThe input parameters of the API operation change.
      Added Input Parameters: ResourceGroupId