CreateDeviceDistributeJob_物联网平台_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用说明

您可参考以下步骤,完成设备分发。

  1. 调用本接口发起设备分发任务(异步调用),获取返回参数 JobId

  2. 将上一步的返回参数 JobId 作为请求参数,重复调用接口 QueryDeviceDistributeJob ,查看返回参数 Status

    说明 您需根据接口的 QPS 限制,控制重复调用接口的频率。

    Status 值如下,表示分发任务已处于最终态:

    • 2:设备分发任务正常执行完成。此时,不代表所有设备分发成功,每个设备的具体分发结果,请执行下一步获取。
    • 3:分发异常中断。处理异常流后,可重新发起设备分发任务。
  3. 将第一步的返回参数 JobId 作为请求参数,调用接口 QueryDeviceDistributeDetail ,获取返回参数 File,即分发结果的文件 URL。

    说明 文件 URL 的有效期为 10 分钟。
  4. 通过文件 URL 获取分发结果详情,其中每个设备对应一个分发结果 Code,当 Code 为 200 时,表示该设备分发成功。

    如果设备分发失败,您可按照以上操作,重新进行设备分发。

限制说明

  • 调用云服务的接入地址 Endpoint 仅支持华东 2(上海),即iot.cn-shanghai.aliyuncs.com

  • 不支持调用本接口创建跨账号的分发任务。

  • 单个阿里云账号下,产品分发和设备分发的任务总数不超过 10 个。创建产品分发任务,请参见 CreateProductDistributeJob

  • 单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为 2。

    说明 RAM 用户共享阿里云账号配额。

流控信息

请求速率为2/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
iot:CreateDeviceDistributeJob
Create
全部资源
*

请求参数

字段名称字段详情
DeviceNamearray<string>

待分发的设备名称列表。最多包含 1000 个设备名称。

示例值:RepeatList子级条数 <= 10000
TargetInstanceConfigarray<object>

目标实例配置列表。

子级条数 <= 10
SourceInstanceIdstring

设备所属的源实例 ID。展开详情

示例值:iot-060***
ProductKeystring

设备所属产品的 ProductKey

示例值:a1BwAGV****参考取值来源:
    CreateProduct
    QueryProductList
    ReleaseProduct
    ListProductByTags
    BindLicenseProduct
    BatchBindProductsIntoProject
TargetUidstring

设备所属的阿里云账号 ID。可登录物联网平台控制台,单击账号头像,跳转至安全设置页面查看。展开详情

示例值:198***
TargetAliyunIdstring

设备所属的阿里云账号。可登录物联网平台控制台,单击账号头像,跳转至安全设置页面查看。展开详情

示例值: io****@example.com
Strategyinteger<int32>

分发策略。默认值为 0。展开详情

示例值:0

请求说明

调用 API 时,除了本文介绍的该 API 的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回参数

字段名称字段详情
Codestring

调用失败时,返回的错误码。更多信息,请参见错误码

示例值:iot.system.SystemException
ErrorMessagestring

调用失败时,返回的出错信息。

示例值:系统异常
RequestIdstring

阿里云为该请求生成的唯一标识符。

示例值:E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565
Successboolean

表示是否调用成功。展开详情

示例值:true
JobIdstring

调用成功后,返回的任务 ID。任务的全局唯一标识符。

示例值:UbmsMHmkqv0PiAG****010001

返回示例

变更历史

暂无变更历史

相关示例

物联网平台/设备划归/设备分发
2022-03-04