DescribeTags API Reference for Region-Level Tag Queries - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Queries all tags in a region.

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

kvstore:DescribeTags

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ResourceType	string	No	The resource type. Valid values: INSTANCE or instance.	INSTANCE
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Note This parameter is not required for the first request. If not all results are returned in one query, you can specify the token that is obtained from the previous query as the value of NextToken.	212db86sca4384811e0b5e8707ec2****

Response elements

Element	Type	Description	Example
	object
NextToken	string	The pagination token to use in the next request to get the next page. If this field is empty, there are no more results. Note If not all results are returned in one query, this parameter is returned. You can pass in the returned value of this parameter for the next query.	212db86sca4384811e0b5e8707ec2****
RequestId	string	The request ID.	F3F44BE3-5419-4B61-9BAC-E66E295A****
Tags	array<object>	The details of the tags.
	object	The information about the tag.
TagKey	string	The key of the tag.	size
TagValues	array	The tag values.
	string	The value of the tag	['test_value_2']

Examples

Success response

JSON format

{
  "NextToken": "212db86sca4384811e0b5e8707ec2****",
  "RequestId": "F3F44BE3-5419-4B61-9BAC-E66E295A****",
  "Tags": [
    {
      "TagKey": "size",
      "TagValues": [
        "['test_value_2']"
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	InvalidTagKey.Malformed	The specified parameter 'Tag.n.Key' or 'TagKey.n' is not valid.
400	InvalidTagValue.Malformed	The specified parameter 'Tag.n.Value' is not valid.
400	InvalidParameter.ResourceId	The specified parameter 'ResourceId.n' is not valid.
400	MissParameter.TagOrResourceId	The parameter 'Tag.n'' or 'ResourceId.n' is needed.
400	InvalidParameter.Scope	The specified parameter 'Scope' is not valid.
400	NumberExceed.ResourceIds	The ResourceIds parameter's number is exceed.
400	NumberExceed.Tags	The Tags parameter's number is exceed.
400	Duplicate.TagKey	The specified parameter 'Tag.n.Key' is duplicated.
400	InvalidParameter.ResourceType	The specified parameter 'ResourceType' is not valid.
404	InvalidDbInstanceId.NotFound	Specified instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.