将TAG绑定到指定的目标(设备、账号或别名),TAG绑定在10分钟内生效。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
mpush:BindTag | update | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppKey | long | 是 | AppKey 信息。 | 23267207 |
ClientKey | string | 是 | 设备或 account 或 alias,多个 key 用逗号分隔,最多支持 1000 个。 | e2ba19de97604f55b16557673**** |
KeyType | string | 是 | ClientKey 的类型。可取值:
| DEVICE |
TagName | string | 是 | 绑定的 Tag,多个 Tag 用逗号分隔,一次最多能绑定 10 个 Tag。标签名称设置要小于等于 128 个字符(中文算 1 个),每个 App 最多可创建 10000 个标签,单设备可以绑定多个标签。 说明
不建议在单个标签上绑定超过十万级设备,否则,发起对该标签的推送可能需要较长的处理时间,无法保障响应速度。此种情况下,建议您采用全推方式,或将设备集合拆分到更细粒度的标签,多次调用推送接口分别推送给这些标签来避免此问题。
| test_tag,test_tag2 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "82FD0A09-5BB8-40FB-8221-9A11FE92D620"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 服务端错误,建议重试,仍然失败则提工单 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-01-25 | OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更 | 查看变更详情 |