Query tagged resources with ListTagResources - Microservices Engine - Alibaba Cloud - Microservices Engine

Queries tagged resources.

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

mse:ListTagResources

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region.	cn-hangzhou
NextToken	string	No	The pagination token for the next query.	AAAAAV3MpHK1AP0pfERHZN5pu6kywps2Ezza3n8HAAzCCqsi
ResourceType	string	Yes	The type of the resource. Valid values: CLUSTER: MSE instance GATEWAY: cloud-native gateway	CLUSTER
ResourceId	array	No	The resource IDs. You can specify a maximum of 50 resource IDs.
	string	No	The ID of a resource.	mse-cn-7pp2st29t16
Tag	array<object>	No	The tags to filter by. You can specify up to 20 tags.
	object	No	A tag key-value pair.
Key	string	No	The key of the tag.	env
Value	string	No	The value of the tag.	prd
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	The data structure.
NextToken	string	The pagination token for the next query. If this parameter is empty, all results have been returned.	AAAAAV3MpHK1AP0pfERHZN5pu6ng3BeUyo2zbY5wgL1DBa2T
RequestId	string	The ID of the request.	92ED7C9C-84A2-595F-87FE-354F84C0F739
Message	string	The message returned.	The request was successfully processed.
ErrorCode	string	The error code returned if the request failed.	mse-100-000
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
TagResources	object
TagResource	array<object>	The list of resources.
	object	The details of a tagged resource, including the resource ID, resource type, tag key, and tag value.
ResourceId	string	The ID of the resource.	mse-cn-7pp2st29t16
ResourceType	string	The type of the resource.	cluster
TagValue	string	The tag value.	prd
TagKey	string	The tag key.	env

Examples

Success response

JSON format

{
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6ng3BeUyo2zbY5wgL1DBa2T",
  "RequestId": "92ED7C9C-84A2-595F-87FE-354F84C0F739",
  "Message": "The request was successfully processed.\n",
  "ErrorCode": "mse-100-000",
  "Success": true,
  "TagResources": {
    "TagResource": [
      {
        "ResourceId": "mse-cn-7pp2st29t16",
        "ResourceType": "cluster",
        "TagValue": "prd",
        "TagKey": "env"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.