ListTagResources API Overview for Tag Visibility - API Gateway

Operation description

In Tag.N.Key and Tag.N.Value, the same value for N represents a single key-value pair.
The query returns only resources that match all specified tags. If you specify resource IDs, the query searches only within those resources.
The query returns resource-tag relationships that meet the specified conditions. If no matching relationships are found, an empty list is returned.
The query includes both user tags and visible system tags.
In addition to the required parameters, specify ResourceId.N to query visible resource-tag relationships for specific resources in a region.
In addition to the required parameters, specify Tag.N.Key to query visible resource-tag relationships for a specific tag key in a region.
Specify at least one resource ID (ResourceId.N) or one tag (Tag.N.Key and Tag.N.Value).
In a single operation, the tags can be of the same or different types.
You have full permissions to query user tags and can query visible system tags.

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

apigateway:ListTagResources

get

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#ResourceId}

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	Yes	The type of the resource. Valid values: apiGroup plugin app api	apiGroup
NextToken	string	No	The token to retrieve the next page of results.	1d2db86sca4384811e0b5e8707e68181f
ResourceId	array	No	The IDs of the resources. You can specify up to 50 resource IDs.	285bb759342649a1b70c2093a772e087
	string	No
Tag	array<object>	No	Specify the object tags to which the rule applies. You can specify multiple tags.
	object	No
Key	string	No	The tag key. The value of N ranges from 1 to 20.	env
Value	string	No	The value of the tag. If you specify this parameter, you must also specify the corresponding Tag.N.Key parameter. You can specify up to 20 tag values.	product

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token to retrieve the next page of results. A value of -1 indicates that no more results are available.	1d2db86sca4384811e0b5e8707e68181f
RequestId	string	The ID of the request.	2D69A58F-345C-4FDE-88E4-BF5189484043
TagResources	object
TagResource	array<object>	The list of resources.
	object
TagValue	string	The value of the tag.	zhangsan
ResourceType	string	The type of the resource.	apiGroup
ResourceId	string	The ID of the resource.	285bb759342649a1b70c2093a772e087
TagKey	string	The key of the tag.	owner

Examples

Success response

JSON format

{
  "NextToken": "1d2db86sca4384811e0b5e8707e68181f",
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF5189484043",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "zhangsan",
        "ResourceType": "apiGroup",
        "ResourceId": "285bb759342649a1b70c2093a772e087",
        "TagKey": "owner"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.