All Products
Search
Document Center

Simple Log Service:ListTagResources

Last Updated:Jan 25, 2024

Queries the tags of resources. You can specify multiple resources of the same type in a request or filter resources by tag. Each tag is a key-value pair.

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 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.

Action

Resource

log:ListTagResources

The resource format varies with 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers and does not have operation-specific request headers. For more information, see Common request parameters.

Request syntax

GET /tags HTTP/1.1

Request parameters

Parameter

Type

Position

Required

Example

Description

resourceType String Query Yes project

The type of the resource. Valid values:

  • project
  • logstore
  • dashboard
  • MachineGroup
  • LogtailConfig
resourceId Array of String Query No ali-test-project

The resource ID. 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
tags Array Query No

The tags that you want to use to filter resources based on exact match. Each tag is a key-value pair. You must configure at least one of the resourceId and tags parameters.

You can specify up to 20 tags.

key String Query Yes key1

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.

value String Query No value1

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.

Response parameters

Parameter

Type

Example

Description

Server String nginx

The name of the server.

Content-Type String application/json

The format of the response body.

Content-Length String 0

The length of the response body.

Connection String close

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.
Date String Sun, 27 May 2018 08:25:04 GMT

The time when the response was returned.

x-log-requestid String 5B0A6B60BB6EE39764D458B5

The request ID.

nextToken String caeba0bbb2be03f84eb48b699f0a4883

The token that is required for the next query.

tagResources Array

The returned tags.

resourceId String ali-test-project

The resource ID.

resourceType String project

The type of the resource.

tagKey String key1

The key of the tag.

tagValue String value1

The value of the tag.

Examples

Sample requests

GET /tags?resourceType=project&resourceId=["ali-test-project"]&tags=[{"key":"key1","value":"value1"}] HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, see Service error codes.