Batch-Tag API Gateway Resources via TagResources API - API Gateway

Operation description

All tags apply to all resource IDs in the list. This means that each ResourceId.N is associated with all specified key-value pairs.
For Tag.N.Key and Tag.N.Value, the same N value indicates a matching key-value pair.
Tag multiple resources in one call. The operation either succeeds for all resources or fails for all resources.
If you specify Tag.1.Value, you must also specify Tag.1.Key. Otherwise, the system returns the error InvalidParameter.TagKey. If you specify a Tag.N.Value, the corresponding Tag.N.Key must exist. The Tag.N.Key value can be an empty string.
If you specify a resource and a tag key that already exists, the existing tag value is overwritten.

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:TagResources

create

*ApiGroup

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

*App

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

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	Yes	Resource type. Currently, groups, plug-ins, and applications support tags. API-related operations use group-level tags: apiGroup plugin app api	apiGroup
Tag	array<object>	Yes	The tag value of the resource.	2021022811
	object	No
Key	string	Yes	Tag key. n ranges from 1 to `20`.	env
Value	string	Yes	Tag value. n ranges from 1 to `20`.	' '
ResourceId	array	Yes	Resource ID. n ranges from 1 to `50`.	285bb759342649a1b70c2093a772e087
	string	No

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	EF924FE4-2EDD-4CD3-89EC-34E4708574E7

Examples

Success response

JSON format

{
  "RequestId": "EF924FE4-2EDD-4CD3-89EC-34E4708574E7"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.