Remove Tags from API Gateway Resources - API Gateway - Alibaba Cloud - API Gateway

Operation description

When you untag multiple resources simultaneously, either all or none of the resources are untagged.
If you specify resource IDs without specifying tag keys and set the All parameter to true, all tags bound to the specified resources are deleted. If a resource does not have any tags, the request is not processed but a success is returned.
If you specify resource IDs without specifying tag keys and set the All parameter to false, the request is not processed but a success is returned.
When tag keys are specified, the All parameter is ignored.
When multiple resources and key-value pairs are specified, the matching tags are deleted from the 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

apigateway:UntagResources

delete

*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	The type of the resource. Tags can be bound to API groups, plug-ins, and applications, allowing you to manage cloud resources by group. Valid values: apiGroup plugin app	apiGroup
All	boolean	No	Specifies whether to delete all tags. This parameter takes effect only when TagKey.N is not specified. Default value: false. Valid values: true false	true
ResourceId	array	Yes	The resource IDs.	285bb759342649a1b70c2093a772e087
	string	No	The ID of the resource. Valid values of N: `1 to 50.`	285bb759342649a1b70c2093a772e087
TagKey	array	No	The tag keys of the resource.	env
	string	No	The key of tag N. Valid values of N: `1 to 20.`	thirdparty

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.