All Products
Search
Document Center

Tair (Redis® OSS-Compatible):DescribeParameterGroup

Last Updated:Oct 30, 2024

Queries the basic information about a parameter template.

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.

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

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterGroupIdstringYes

The ID of the parameter template.

rpg-sys-00*****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

A501A191-BD70-5E50-98A9-C2A486A82****
ParameterGroupobject

The information about the parameter template.

EngineVersionstring

The compatible engine version.

5.0
Modifiedstring

The time when the parameter template was last modified.

2023-04-18 16:32:45
ParameterGroupNamestring

The name of the parameter template.

testGroupName
ParameterGroupDescstring

The description of the parameter template.

test
ParamGroupIdstring

The parameter template ID, which is globally unique.

sys-001*****
Createdstring

The time when the parameter template was created.

2023-04-18 16:32:45
Categorylong

The service category. Valid values:

  • 0: Community Edition
  • 1: Enhanced Edition (Tair)
1
ParamGroupsDetailsarray<object>

The parameter details of the parameter template.

ParamGroupDetailobject
ParamNamestring

The name of the parameter.

timeout
ParamValuestring

The value of the parameter.

1000

Examples

Sample success responses

JSONformat

{
  "RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****",
  "ParameterGroup": {
    "EngineVersion": "5.0",
    "Modified": "2023-04-18 16:32:45",
    "ParameterGroupName": "testGroupName",
    "ParameterGroupDesc": "test",
    "Engine": "redis",
    "ParamGroupId": "sys-001*****",
    "Created": "2023-04-18 16:32:45",
    "Category": 1,
    "ParamGroupsDetails": [
      {
        "ParamName": "timeout",
        "ParamValue": "1000"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-06-17The request parameters of the API has changedView Change Details