All Products
Document Center

Message Queue for Apache Kafka:UntagResources

Last Updated:Jan 16, 2023

Detaches tags from a specified resource.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operate access level Resource type conditional keyword Association operation
alikafka:UntagResources Write
    All resources

Request parameters

Parameter Type Required Description Example
RegionId string Yes

The ID of the region in which the resource is deployed.

ResourceType string Yes

The type of the resources from which you want to detach tags. Valid values:

Note The value of this parameter is not case-sensitive.
All boolean No

Specifies whether to detach all tags from the resource. This parameter only takes effect when the TagKey.N parameter is not configured. Default value: false.

ResourceId array Yes

The IDs of the resources from which you want to detach tags.

string No

Take note of the following rules when you specify a resource ID:

  • The resource ID of an instance is the value of the instanceId parameter.
  • The resource ID of a topic is the value of the Kafka_instanceId_topic parameter.
  • The resource ID of a group is the value of the Kafka_instanceId_consumerGroup parameter.

For example, the resources from which you want to detach tags include the alikafka_post-cn-v0h1fgs2xxxx instance, the test-topic topic, and the test-consumer-group consumer group. In this case, their resource IDs are alikafka_post-cn-v0h1fgs2xxxx, Kafka_alikafka_post-cn-v0h1fgs2xxxx_test-topic, and Kafka_alikafka_post-cn-v0h1fgs2xxxx_test-consumer-group.

TagKey array No

The tag keys of the resource.

string No
  • If you want to configure this parameter, specify at least one tag key and at most 20 tag keys.
  • If this parameter is not configured and the All parameter is set to true, all tag keys are matched.
  • The tag key can be up to 128 characters in length. The tag key cannot start with acs: or aliyun or contain http:// or https://.

Response parameters

Parameter Type Description Example
RequestId string

The ID of the request.



Normal return example


  "RequestId": "C46FF5A8-C5F0-4024-8262-B16B6392****"

Error codes

For a list of error codes, visit the API error center.