調用該介面建立產品分發任務,將指定產品分發到指定的目標執行個體。
使用說明
- 調用雲端服務的接入地址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
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。