ListTagResources - OpenSearch - Alibaba Cloud Documentation Center

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

opensearch:ListTagResources

get

*AppGroup

acs:opensearch:{#regionId}:{#accountId}:instance/{#AppGroupId}

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 of 50 resource IDs.
	string	No	A list of resource IDs to query. You must specify this parameter or the `tag` parameter.	i-bp185wwblwfvh1a1y1me
tag	array<object>	No	The tags to query. The list can contain a maximum of 20 tags.
	object	No	The internal English representation of the entity type.
key	string	No	The tag key.	bm
value	string	No	The tag value.	Uefi
nextToken	string	No	The token to start the next query.	60

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	D77D0DAF-790D-F5F5-A9C0-133738165014
nextToken	string	The token to start the next query.	20
result	array<object>	The list of resources.
	object	The returned result.
tagKey	string	The tag key.	GENIE_FUNCTION
tagValue	string	The tag value.	ALLOW
resourceId	string	The resource ID.	54041
resourceType	string	The resource type.	hostGroup

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.