Call ListTagResources to query relationships between instances and tags - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

You can also query tag bindings in the Tair (Redis OSS-compatible) console. For more information, see Filter Tair (Redis OSS-compatible) instances by tag and View tags bound to an instance.

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:ListTagResources

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
ResourceType	string	Yes	The resource type. Set the value to INSTANCE.	INSTANCE
NextToken	string	No	The token used to start the next query for more results. Note This parameter is not required in the first query. If not all results are returned in one query, specify the NextToken value returned by the previous query to retrieve the remaining results.	212db86sca4384811e0b5e8707ec2****
ResourceId	array	No	The IDs of the instances. Note You must specify this parameter or the Tag parameter.	r-bp1zxszhcgatnx****
	string	No	The ID of the instance.	r-bp1zxszhcgatnx****
Tag	array<object>	No	The tags of the instance. You must specify this parameter or the ResourceId parameter.
	object	No
Key	string	No	The tag keys of the instances to query.	demokey
Value	string	No	The tag values of the instances to query.	demovalue

Response elements

Element	Type	Description	Example
	object	The response parameters.
NextToken	string	The token for retrieving more results. If a query does not return all results, specify the token returned by the previous query to retrieve the remaining results.	212db86sca4384811e0b5e8707ec2****
RequestId	string	The request ID.	47A514A1-4B77-4E30-B4C5-2A880650****
TagResources	object
TagResource	array<object>	Details about the instances and tags.
	object	The tag that is added to the instance.
TagValue	string	The values of the tags.	demovalue
ResourceType	string	The resource type. The return value is ALIYUN::KVSTORE::INSTANCE, which indicates a Tair (Redis OSS-compatible) instance.	ALIYUN::KVSTORE::INSTANCE
ResourceId	string	The resource ID, which is the instance ID.	r-bp1zxszhcgatnx****
TagKey	string	The keys of the tags.	demokey

Examples

Success response

JSON format

{
  "NextToken": "212db86sca4384811e0b5e8707ec2****",
  "RequestId": "47A514A1-4B77-4E30-B4C5-2A880650****",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "demovalue",
        "ResourceType": "ALIYUN::KVSTORE::INSTANCE",
        "ResourceId": "r-bp1zxszhcgatnx****",
        "TagKey": "demokey"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.	The parameters Tag and ResourceId cannot all be empty. At least one of them is passed in.
400	InvalidParameter.Scope	The specified parameter Scope is not valid.
400	NumberExceed.ResourceIds	The ResourceIds parameter number is exceed.
400	NumberExceed.Tags	The Tags parameter 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.