All Products
Search
Document Center

CloudOps Orchestration Service:ListTagResources

Last Updated:Oct 14, 2024

Queries the tags that are added to one or more resources.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
oos:ListTagResourcesget
  • 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
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

cn-hangzhou
ResourceIdsobjectNo

The IDs of resources. The number of resource IDs ranges from 1 to 50.

["templateNam1","templateName2"]
ResourceTypestringYes

The type of the resource. Valid values: template execution

template
TagsobjectNo

The tag keys and values. The number of key-value pairs ranges from 1 to 20.

{"k1":"v2","k2":"v2"}
NextTokenstringNo

The pagination token that is 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 parameters

ParameterTypeDescriptionExample
object
NextTokenstring

The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. If the return value of the NextToken parameter is empty, the next page does not exist.

MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ
RequestIdstring

The ID of the request.

A5EF78C1-67FC-4E36-A6A8-7DF9C51726DF
TagResourcesarray<object>

The set of resources and the tags that are added to the resources.

TagResourceobject
ResourceTypestring

The type of the resource.

template
TagValuestring

The tag value.

v1
ResourceIdstring

The ID of the resource.

TagTest2
TagKeystring

The tag key.

k1

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history