BindAlias

更新时间:
复制 MD 格式

Attach an alias to a device.

Operation description

You can attach up to 10 aliases in a single request. The attachment takes effect immediately.

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:BindAlias

update

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

AppKey

integer

Yes

Your AppKey.

23267207

DeviceId

string

Yes

The unique identifier of the device in Mobile Push. It is 32 characters long and contains only numbers and lowercase letters.

e2ba19de97604f55b16557673****

AliasName

string

Yes

The alias to attach.

You can attach up to 10 aliases in one request. Separate multiple aliases with commas. Each alias can be up to 128 bytes long. Chinese characters count as three bytes each. A device can have up to 128 aliases attached. An alias can be attached to up to 128 devices.

test_alias

Response elements

Element

Type

Description

Example

object

RequestId

string

The ID of the request.

159E4422-6624-4750-8943-DFD98D34858C

Examples

Success response

JSON format

{
  "RequestId": "159E4422-6624-4750-8943-DFD98D34858C"
}

Error codes

HTTP status code

Error code

Error message

Description

400 Invalid%s.Format The specified %s format is invalid.
400 Invalid%s.BytesExceed The specified %s exceeds the %s bytes limit.
400 AccountDisabled Your account is not enabled.
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.