TagResources - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

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

mq:TagResources

create

*All Resource

*

None

mq:MqttInstanceAccess

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	Yes	The resource type. The value must be instance.	instance
ResourceId	array	Yes	A list of resource IDs.
	string	No	The resource ID. Currently, only instances are supported.	mqtt-cn-5yd3xxx
Tag	array<object>	Yes	A list of tags. You can add up to 20 tags at a time. A resource can have a maximum of 20 tags.
	object	No	The tag object of the resource.
Key	string	No	The tag key.	test
Value	string	No	The tag value.	test

Response elements

Parameter	Type	Description	Example
	object	The returned object.
RequestId	string	The ID of the request.	82B9E503-F4A1-4F30-976F-C6999FF9****
Code	string	The status code of the API call.	200
Data	boolean	The result of the call.	true
Message	string	The returned message.	operation success.

Examples

Success response

JSON format

{
  "RequestId": "82B9E503-F4A1-4F30-976F-C6999FF9****",
  "Code": "200",
  "Data": true,
  "Message": "operation success."
}

Error codes

HTTP status code	Error code	Error message
400	MqttOwnerCheckError	Failed to validate the instance permission
400	ResourceIdNotFound	resourceId does not exist.
403	PermissionCheckFailed	Failed to verify API permissions.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.