ListTagResources - OpenSearch - Alibaba Cloud Documentation Center

Queries tagged 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
opensearch:ListTagResources	get	AppGroup acs:opensearch:{#regionId}:{#accountId}:instance/{#AppGroupId}	none	none

Request syntax

GET /v4/openapi/resource-tags HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
resourceType	string	Yes	The resource type.	BIGDATA
resourceId	array	No	The resource IDs. You can specify a maximum number of 50 resource IDs.
	string	No	The IDs of the resources that you want to query. You must configure at least one of the resourceId and tag parameters.	i-bp185wwblwfvh1a1y1me
tag	array<object>	No	The tags. You can specify a maximum number of 20 tags.
	object	No	The internal name of the entity type.
key	string	No	The key of the tag.	bm
value	string	No	The value of the tag.	Uefi
nextToken	string	No	The token that is used to retrieve the next page.	60

Response parameters

Parameter	Type	Description	Example
	object
requestId	string	The ID of the request.	D77D0DAF-790D-F5F5-A9C0-133738165014
nextToken	string	The token that is used to retrieve the next page.	20
result	array<object>	The resources.
TagResource	object	The result of the request.
tagKey	string	The key of the tag.	GENIE_FUNCTION
tagValue	string	The value of the tag.	ALLOW
resourceId	string	The ID of the resource.	54041
resourceType	string	The resource type.	hostGroup

Examples

Sample success responses

JSONformat

{
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "nextToken": "20",
  "result": [
    {
      "tagKey": "GENIE_FUNCTION",
      "tagValue": "ALLOW",
      "resourceId": "54041",
      "resourceType": "hostGroup"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history