All Products
Search
Document Center

API Gateway:UntagResources

Last Updated:Mar 01, 2024

Removes tags from resources.

Operation description

  • If you call this operation to untag multiple resources simultaneously, either all or none of the resources will be untagged.
  • If you specify resource IDs without specifying tag keys and set the All parameter to true, all tags bound to the specified resources will be 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 invalid.
  • When multiple resources and key-value pairs are specified, the specified tags bound to the resources are deleted.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:UntagResourcesWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceTypestringYes

The type of the resource. Tags are bound to API groups, plug-ins, and applications. You can use tags to manage cloud resources by group. Valid values:

  • apiGroup
  • plugin
  • app
apiGroup
AllbooleanNo

Specifies whether to delete all tags. This parameter is valid only when the TagKey.Nparameter is not specified. Default value: false. Valid values:

  • true
  • false
true
ResourceIdarrayYes

The resource IDs.

stringYes

The ID of the resource.

Valid values of N: 1 to 50.

285bb759342649a1b70c2093a772e087
TagKeyarrayNo

The tag keys of the resource.

stringNo

The key of tag N.

Valid values of N: 1 to 20.

thirdparty

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history