Query resource tags by using ListTagResources - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

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

ehpc:ListTagResources

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the resource.	cn-hangzhou
NextToken	string	No	The token used to start the next query.	caeba0bbb2be03f84eb48b699f0axxxx
ResourceType	string	Yes	The resource type. Set the value to cluster, which indicates E-HPC clusters.	cluster
ResourceId	array	No	The resource IDs. You can specify up to 50 IDs.
	string	No	The resource IDs. You can specify up to 50 IDs.	ehpc-hz-xxxx
Tag	array<object>	No	The resource tags. You can specify up to 20 tags.
	object	No	The resource tags. You can specify up to 20 tags.
Key	string	No	The tag key.	TestKey
Value	string	No	The tag value.	TestValue

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token for the next query. If empty, no more results are available.	caeba0bbb2be03f84eb48b699f0axxxx
RequestId	string	The request ID.	484256DA-D816-44D2-9D86-B6EE4D5BA78C
TagResources	object
TagResource	array<object>	The tags.
	object
ResourceType	string	The type of the resource whose tags are queried. Set the value to cluster, which indicates E-HPC clusters.	cluster
TagValue	string	The tag value.	TestValue
ResourceId	string	The resource ID. Set the value to the ID of the cluster.	ehpc-hz-xxxx
TagKey	string	The tag key.	TestKey

Examples

Success response

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0axxxx",
  "RequestId": "484256DA-D816-44D2-9D86-B6EE4D5BA78C",
  "TagResources": {
    "TagResource": [
      {
        "ResourceType": "cluster",
        "TagValue": "TestValue",
        "ResourceId": "ehpc-hz-xxxx",
        "TagKey": "TestKey"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
404	ClusterNotFound	The specified cluster does not exist.	The specified instance does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The request has failed due to a temporary failure of the server.
406	TagError	TAG API request failed.
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.