All Products
Search
Document Center

:ListTagResources

Last Updated:Jul 25, 2024

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.
  • An AccessKey pair is created and obtained. For more information, see AccessKey pair.

The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Simple Log Service.

  • The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see Manage a project
  • For more information, see Authorization rules. The following types of resources are supported: project, Logstore, dashboard, machine group, and Logtail configuration.

Authentication resources

The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.

ActionResource
log:ListTagResourcesThe resource format varies based on the resource type.-acs:log:{#regionId}:{#accountId}:project/{#ProjectName}-acs:log:${regionName}:${accountId}:project/${projectName}/logstore/${logstoreName}-acs:log:${regionName}:${accountId}:project/${projectName}/dashboard/${dashboardName}-acs:log:${regionName}:${accountId}:project/${projectName}/machinegroup/${machineGroupName}-acs:log:${regionName}:${accountId}:project/${projectName}/logtailconfig/${logtailConfigName}

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /tags

Request parameters

ParameterTypeRequiredDescriptionExample
resourceTypestringYes

The type of the resource. Valid values:

  • project
  • logstore
  • dashboard
  • MachineGroup
  • LogtailConfig
project
resourceIdarrayNo

The IDs of the resources whose tags you want to query. You must specify at least one of resourceId and tags.

stringNo

The ID of the resource. In this example, a Logstore is used. projectName indicates the project name. # is used to concatenate strings. logstore indicates the Logstore name.

  • project: projectName
  • logstore: projectName#logstore
  • dashboard: projectName#dashboard
  • MachineGroup: projectName#MachineGroup
  • LogtailConfig: projectName#LogtailConfig
ali-test-project
tagsarray<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.

objectNo
keystringYes

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
valuestringNo

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

ParameterTypeDescriptionExample
headersobject
Serverstring

The name of the server.

nginx
Content-Typestring

The content type of the response body.

application/json
Content-Lengthstring

The content length of the response body.

0
Connectionstring

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
Datestring

The time when the response was returned.

Sun, 27 May 2018 08:25:04 GMT
x-log-requestidstring

The request ID.

5B0A6B60BB6EE39764D458B5
object

The returned struct.

nextTokenstring

The pagination token that is used in the next request to retrieve a new page of results.

caeba0bbb2be03f84eb48b699f0a4883
tagResourcesarray<object>

The returned tags.

object
resourceIdstring

The ID of the resource.

ali-test-project
resourceTypestring

The type of the resource.

project
tagKeystring

The key of the tag.

key1
tagValuestring

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.