All Products
Search

This Product

    ApsaraMQ for RocketMQ:TagResources

    Document Center

    ApsaraMQ for RocketMQ:TagResources

    Last Updated:Mar 03, 2024

    Attaches tags to resources.

    Operation description

    Note API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.

    You can call this operation to attach tags to a source. You can use tags to classify resources in ApsaraMQ for RocketMQ. This can help you aggregate and search resources in an efficient manner.

    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
    mq:TagResourcesRead
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringNo

    The ID of the ApsaraMQ for RocketMQ instance that contains the resource to which you want to attach tags.

    Note This parameter is required when you attach tags to a topic or a group.
    		MQ_INST_188077086902****_BXSuW61e
    ResourceTypestringYes

    The type of the resource to which you want to attach tags. Valid values:

    • INSTANCE
    • TOPIC
    • GROUP
    		TOPIC
    Tagobject []Yes

    The tags that you want to attach to the resource.

    KeystringYes

    The tag key. If you configure this parameter, you must also configure the Value parameter.****

    • The value of this parameter cannot be an empty string.
    • A tag key must be 1 to 128 characters in length and cannot contain http:// or https://. A tag key cannot start with acs: or aliyun.
    		FinanceDept
    ValuestringYes

    The value of the tag that you want to attach to the resource. If you configure this parameter, you must also configure the Key parameter.****

    • The value of this parameter can be an empty string.
    • A tag value must be 1 to 128 characters in length and cannot contain http:// or https://. A tag value cannot start with acs: or aliyun.
    		FinanceJoshua
    ResourceIdarrayYes

    The resource IDs.

    stringYes

    The ID of the resource to which you want to attach a tag.

    • If the resource is a ApsaraMQ for RocketMQ instance, specify the ID of the instance.
    • If the resource is a topic, specify the topic name.
    • If the resource is a group, specify the ID of the group.
    		TopicA

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use the ID to troubleshoot issues.

    		301D2CBE-66F8-403D-AEC0-82582478****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "301D2CBE-66F8-403D-AEC0-82582478****"
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    No change history

    Attach tags to a resource in the console

    You can also attach tags to a resource in the ApsaraMQ for RocketMQ console.**** For more information, see Manage tags.