调用该接口创建产品分发任务,将指定产品分发到指定的目标实例。
使用说明
- 调用云服务的接入地址Endpoint仅支持华东2(上海),即
iot.cn-shanghai.aliyuncs.com
。 - 不支持调用本接口创建跨账号的分发任务。
- 产品分发任务不会同步分发产品下设备。
- 产品分发完成后,不支持修改产品的物模型及相关脚本信息。
- 单个阿里云账号下,产品分发和设备分发的任务总数不超过10个。创建设备分发任务,请参见CreateDeviceDistributeJob。
-
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为2。说明 RAM用户共享阿里云账号配额。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateProductDistributeJob |
系统规定参数。取值:CreateProductDistributeJob。 |
ProductKey | String | 是 | a1BwAGV**** |
待分发产品的ProductKey。 |
SourceInstanceId | String | 是 | iot-cn-st2*** |
产品所属的源实例ID。
|
TargetInstanceId | String | 是 | iot-cn-6ja*** |
产品分发的目标实例ID。实例ID详情,请参见参数SourceInstanceId描述。 |
TargetUid | String | 否 | 198*** |
产品所属的阿里云账号ID。可登录物联网平台控制台,单击账号头像,跳转至基本信息页面查看账号ID。 TargetUid与TargetAliyunId参数至少传入一个。 |
TargetAliyunId | String | 否 | io****@example.com |
产品所属的阿里云账号。可登录物联网平台控制台,单击账号头像,跳转至基本信息页面查看登录账号。 TargetUid与TargetAliyunId参数至少传入一个。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | iot.system.SystemException |
调用失败时,返回的错误码。更多信息,请参见错误码。 |
ErrorMessage | String | 系统异常 |
调用失败时,返回的出错信息。 |
JobId | String | UbmsMHmkqv0PiAG****010001 |
调用成功后,返回的任务ID。任务的全局唯一标识符。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
表示是否调用成功。
|
示例
请求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateProductDistributeJob
&ProductKey=a1BwAGV****
&SourceInstanceId=iot-cn-st2***
&TargetInstanceId=iot-cn-6ja***
&TargetAliyunId=io****@example.com
&<公共请求参数>
正常返回示例
XML
格式
<CreateProductDistributeJobResponse>
<RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
<JobId>UbmsMHmkqv0PiAG****010001</JobId>
<Success>true</Success>
</CreateProductDistributeJobResponse>
JSON
格式
{
"RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
"JobId": "UbmsMHmkqv0PiAG****010001",
"Success": true
}