Use ListTagResources to query tags on resources - Resource Orchestration Service - Alibaba Cloud - Resource Orchestration Service

Operation description

To specify the query object, specify ResourceId or Tag in the request. Tag consists of Key and Value.
If you specify Tag and ResourceId, ROS resources that match both the parameters are returned.

This topic provides an example on how to query the tags that are added to a stack. In this example, the stack ID is 6bc589b5-9c02-4944-8fc3-f3624234****. The stack is deployed in the China (Hangzhou) 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

ros:ListTagResources

get

Template

acs:ros:{#regionId}:{#accountId}:template/{#TemplateId}

StackGroup

acs:ros:{#regionId}:{#accountId}:stackgroup/{#StackGroupName}

TemplateScratch

acs:ros:{#regionId}:{#accountId}:templatescratch/{#TemplateScratchId}

Stack

acs:ros:{#regionId}:{#accountId}:stack/{#StackId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the tag. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ResourceType	string	Yes	The type of the resource. Valid values: stack: stack stackgroup: stack group template: template templatescratch: scenario	stack
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results.	caeba0bbb2be03f84eb48b699f0*****
ResourceId	array	No	The IDs of the resources.	6bc589b5-9c02-4944-8fc3-f3624234****
	string	No	The ID of the resource. You can specify up to 50 resource IDs. Note If you set ResourceType to stackgroup, you must set ResourceId to the name of the stack group.	6bc589b5-9c02-4944-8fc3-f3624234****
Tag	array<object>	No	The tags of the resources. You can specify up to 20 tags.
	object	No	The tag of the resource.
Key	string	No	The tag key of the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`.	FinanceDept
Value	string	No	The tag value of the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length, and cannot contain `http://` or `https://`. The tag value cannot start with `aliyun` or `acs:`.	FinanceJoshua

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	caeba0bbb2be03f84eb48b699f0*****
RequestId	string	The ID of the request.	C429473A-5C66-4661-B5F8-4F900CD4330A
TagResources	array<object>	The information about the tags that are added to the resources.
	object	The information about the tag that is added to the resource.
ResourceType	string	The type of the resource.	stack
TagValue	string	The tag value of the resource.	TayValue1
ResourceId	string	The ID of the resource.	c754d2a4-28f1-46df-b557-9586173a****
TagKey	string	The tag key of the resource.	TagKey1

Examples

Success response

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0*****",
  "RequestId": "C429473A-5C66-4661-B5F8-4F900CD4330A",
  "TagResources": [
    {
      "ResourceType": "stack",
      "TagValue": "TayValue1",
      "ResourceId": "c754d2a4-28f1-46df-b557-9586173a****",
      "TagKey": "TagKey1"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.