Query tags on resources by using ListTagResources - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

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

oos:ListTagResources

get

Execution

acs:oos:{#regionId}:{#accountId}:execution/{#executionId}

Template

acs:oos:{#regionId}:{#accountId}:template/{#TemplateName}

StateConfiguration

acs:oos:{#regionId}:{#accountId}:stateconfiguration/{#StateConfigurationId}

Parameter

acs:oos:{#regionId}:{#accountId}:parameter/{#ParameterName}

SecretParameter

acs:oos:{#regionId}:{#accountId}:secretparameter/{#SecretParameterName}

OpsItem

acs:oos:{#regionId}:{#accountId}:opsitem/{#OpsItemId}

PatchBaseline

acs:oos:{#regionId}:{#accountId}:patchbaseline/{#PatchBaselineName}

Execution

acs:oos:{#regionId}:{#accountId}:execution/*

Template

acs:oos:{#regionId}:{#accountId}:template/*

OpsItem

acs:oos:{#regionId}:{#accountId}:opsitem/*

SecretParameter

acs:oos:{#regionId}:{#accountId}:secretparameter/*

PatchBaseline

acs:oos:{#regionId}:{#accountId}:patchbaseline/*

StateConfiguration

acs:oos:{#regionId}:{#accountId}:stateconfiguration/*

Parameter

acs:oos:{#regionId}:{#accountId}:parameter/*

oos:tag
oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ResourceIds	object	No	The resource IDs. You can specify 1 to 50 resource IDs.	["templateNam1","templateName2"]
ResourceType	string	Yes	The resource type. Valid values: template execution	template
Tags	object	No	The tag keys and values. You can specify 1 to 20 key-value pairs.	{"k1":"v2","k2":"v2"}
NextToken	string	No	A pagination token. It can be used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ

Response elements

Element	Type	Description	Example
	object
NextToken	string	A pagination token that can be used in the next request to retrieve a new page of results. If this parameter is empty, no more pages are available.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ
RequestId	string	The request ID.	A5EF78C1-67FC-4E36-A6A8-7DF9C51726DF
TagResources	object
TagResource	array<object>	The resources and their associated tags.
	object
ResourceType	string	The resource type.	template
TagValue	string	The tag value.	v1
ResourceId	string	The resource ID.	TagTest2
TagKey	string	The tag key.	k1

Examples

Success response

JSON format

{
  "NextToken": "MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ",
  "RequestId": "A5EF78C1-67FC-4E36-A6A8-7DF9C51726DF",
  "TagResources": {
    "TagResource": [
      {
        "ResourceType": "template",
        "TagValue": "v1",
        "ResourceId": "TagTest2",
        "TagKey": "k1"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.