ListTagResources - - Alibaba Cloud Documentation Center

Queries a list of tags for one or more resources. You can query tags for resources by resource type or filter resources by tag. Each tag is a key-value pair.

Operation description

Usage notes

Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
log:ListTagResources	Read	Project acs:log:{#regionId}:{#accountId}:project/{#ProjectName}	log:TLSVersion	none

Request syntax

GET /tags

Request parameters

Parameter	Type	Required	Description	Example
resourceType	string	Yes	The type of the resource. Set the value to project.	project
resourceId	array	No	The IDs of the resources for which you want to query tags. You must specify at least one of resourceId and tags.
	string	No	The resource ID. When you set resourceType to project, enter the ID of a project.	ali-test-project
tags	object []	No	The tags that you want to use to filter resources based on exact match. Each tag is a key-value pair. You must specify at least one of resourceId and tags. You can enter up to 20 tags.
key	string	Yes	The key of the tag that you want to use to filter resources. For example, if you set the key to `"test-key"`, only resources to which the key is added are returned.``	key1
value	string	No	The value of the tag that you want to use to filter resources. If you set the value to null, resources are filtered based only on the key of the tag.	value1

Response parameters

Parameter	Type	Description	Example
headers	object
Server	string	The name of the server.	nginx
Content-Type	string	The content type of the response body.	application/json
Content-Length	string	The content length of the response body.	0
Connection	string	Indicates whether the connection is persistent. Valid values: close: The connection is non-persistent. A new TCP connection is established for each HTTP request. keep-alive: The connection is persistent. After a TCP connection is established, the connection remains open, and no more time or bandwidth is consumed to establish new connections.	close
Date	string	The time when the response was returned.	Sun, 27 May 2018 08:25:04 GMT
x-log-requestid	string	The request ID.	5B0A6B60BB6EE39764D458B5
	object	The returned struct.
nextToken	string	The pagination token that is used in the next request to retrieve a new page of results.	caeba0bbb2be03f84eb48b699f0a4883
tagResources	object []	The returned tags.
resourceId	string	The ID of the resource.	ali-test-project
resourceType	string	The type of the resource.	project
tagKey	string	The key of the tag.	key1
tagValue	string	The value of the tag.	value1

Examples

Sample success responses

JSONformat

{
  "nextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "tagResources": [
    {
      "resourceId": "ali-test-project",
      "resourceType": "project",
      "tagKey": "key1",
      "tagValue": "value1"
    }
  ]
}

Error codes

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