All Products
Search

This Product

    Resource Orchestration Service:ListTagResources

    Document Center

    Resource Orchestration Service:ListTagResources

    Last Updated:Sep 12, 2024

    Queries the tags that are added to resources in a template or stack in an Alibaba Cloud region.

    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.

    Debugging

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

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    ros:ListTagResourcesget
    • 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
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the tag. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    ResourceTypestringYes

    The type of the resource. Valid values:

    • stack: stack
    • stackgroup: stack group
    • template: template
    • templatescratch: scenario
    		stack
    NextTokenstringNo

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

    		caeba0bbb2be03f84eb48b699f0*****
    ResourceIdarrayNo

    The IDs of the resources.

    stringNo

    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****
    Tagarray<object>No

    The tags of the resources. You can specify up to 20 tags.

    objectNo

    The tag of the resource.

    KeystringNo

    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
    ValuestringNo

    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 parameters

    ParameterTypeDescriptionExample
    object
    NextTokenstring

    A pagination token. It can be used in the next request to retrieve a new page of results.

    		caeba0bbb2be03f84eb48b699f0*****
    RequestIdstring

    The ID of the request.

    		C429473A-5C66-4661-B5F8-4F900CD4330A
    TagResourcesarray<object>

    The information about the tags that are added to the resources.

    object

    The information about the tag that is added to the resource.

    ResourceTypestring

    The type of the resource.

    		stack
    TagValuestring

    The tag value of the resource.

    		TayValue1
    ResourceIdstring

    The ID of the resource.

    		c754d2a4-28f1-46df-b557-9586173a****
    TagKeystring

    The tag key of the resource.

    		TagKey1

    Examples

    Sample success responses

    JSONformat

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

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    No change history