BindTag-阿里云帮助中心

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

mpush:BindTag

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppKey	integer	Yes	The AppKey of your application.	23267207
ClientKey	string	Yes	The ID of the target device. You can specify a maximum of 1,000 device IDs.	e2ba19de97604f55b16557673****
KeyType	string	Yes	The type of the `ClientKey`. Valid value: DEVICE: Indicates a device target.	DEVICE
TagName	string	Yes	The tags to bind. Separate multiple tags with commas (,). You can bind up to 10 tags per request. A tag name can be up to 128 characters long (each Chinese character counts as 1 character). Each application can have up to 10,000 tags. A single device can be bound to multiple tags. Important Do not bind a single tag to more than 100,000 devices. This practice can increase push processing time and increase response time. Use the full push feature to send notifications to all devices. Split the device set into multiple fine-grained tags and call the push API in batches. Note If you attempt to bind the same tag multiple times, the system automatically removes the duplicates. When a user uninstalls the application from a device, the tags associated with that device are automatically unbound. This unbinding process may be slightly delayed.	test_tag,test_tag2

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	82FD0A09-5BB8-40FB-8221-9A11FE92D620

Examples

Success response

JSON format

{
  "RequestId": "82FD0A09-5BB8-40FB-8221-9A11FE92D620"
}

Error codes

HTTP status code	Error code	Error message	Description
400	AccountDisabled	Your account is not enabled.
400	Invalid%s.Format	The specified %s format is invalid.
400	Invalid%s.NotFound	The specified %s is not found.
500	InternalError	The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.