All Products
Search
Document Center

ApsaraMQ for Kafka:TagResources

Last Updated:Mar 15, 2024

Attaches a tag to a resource.

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
alikafka:TagResourcesWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
ResourceTypestringYes

The type of the resources. The value is an enumerated value. Valid values:

  • INSTANCE
  • TOPIC
  • CONSUMERGROUP
Note The value of this parameter is not case-sensitive.
instance
ResourceIdarrayYes

The list of resource IDs.

stringYes

The ID of the resource to which you want to attach tags. A resource ID complies with the following rules:

  • 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_alikafka_instanceId_topic parameter.
  • The resource ID of a group is the value of the Kafka_alikafka_instanceId_consumerGroup parameter.

For example, the resources to which you want to attach tags include the alikafka_post-cn-v0h1fgs2xxxx instance, the test-topic topic, and the test-consumer-group 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.

alikafka_post-cn-v0h1fgs2****
Tagobject []Yes

The tags that you want to add.

KeystringYes

The tag key.

  • You must specify this parameter.
  • The tag key must be 1 to 128 characters in length and cannot start with acs: or aliyun. The tag key cannot contain http:// or https://.
FinanceDept
ValuestringNo

The tag value.

  • You can leave this parameter empty.
  • The tag value must be 1 to 128 characters in length and cannot start with acs: or aliyun. The tag key cannot contain http:// or https://.
FinanceJoshua
InstanceIdstringNo

The ID of the Message Queue for Apache RocketMQ instance which contains the resource to which you want to attach tags.

alikafka_post-cn-v0h1fgs2****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

C46FF5A8-C5F0-4024-8262-B16B6392****

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2023-11-09The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.