指定されたインスタンスにプロダクトを配布するタスクを作成します。
使用方法
- この操作は、次の エンドポイント を使用してのみ呼び出すことができます：
iot.cn-shanghai.aliyuncs.com。 - この操作を呼び出して、アカウント間でプロダクトを配布することはできません。
- プロダクト配布タスクは、プロダクト下のデバイスを配布しません。
- プロダクトが配布された後、その TSL モデルとスクリプトを変更することはできません。
- 各 Alibaba Cloud アカウントは、プロダクトまたはデバイスを配布するために最大 10 個のタスクを作成できます。デバイス配布タスクの作成方法の詳細については、「CreateDeviceDistributeJob」をご参照ください。
- 各 Alibaba Cloud アカウントは、最大 2 クエリ/秒（QPS）を実行できます。説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。
デバッグ
リクエストパラメーター
| パラメーター | タイプ | 必須 | 例 | 説明 |
| Action | String | Yes | CreateProductDistributeJob | 実行する操作。値を CreateProductDistributeJob に設定します。 |
| ProductKey | String | Yes | a1BwAGV**** | 公開するプロダクトの ProductKey。 |
| SourceInstanceId | String | Yes | iot-cn-st2*** | プロダクトが属するソースインスタンスの ID。
|
| TargetInstanceId | String | Yes | iot-cn-6ja*** | プロダクトが配布される宛先インスタンスの ID。インスタンス ID の詳細については、SourceInstanceId パラメーターの説明をご参照ください。 |
| TargetUid | String | No | 198*** | プロダクトが属する Alibaba Cloud アカウントの ID。IoT Platform コンソールにログインし、プロフィール画像をクリックして、セキュリティ設定 ページで アカウント ID を確認できます。 TargetUid パラメーターと TargetAliyunId パラメーターを同時に空にすることはできません。 |
| TargetAliyunId | String | No | io****@example.com | プロダクトが属する Alibaba Cloud アカウント。IoT Platform コンソールにログインし、プロフィール画像をクリックして、セキュリティ設定 ページで ログインアカウント を確認できます。 TargetUid パラメーターと TargetAliyunId パラメーターを同時に空にすることはできません。 |
上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出す際には、共通のリクエストパラメーターを指定する必要があります。詳細については、「共通リクエストパラメーター」をご参照ください。
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| Code | String | iot.system.SystemException | 呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。 |
| ErrorMessage | String | システム例外が発生しました。 | 呼び出しが失敗した場合に返されるエラーメッセージ。 |
| JobId | String | UbmsMHmkqv0PiAG****010001 | 呼び出しが成功した場合に返されるタスク ID。この ID は、タスクをグローバルに識別します。 |
| RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | リクエストの ID。 |
| 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
}エラーコード
エラーコードのリストについては、API エラーセンターをご参照ください。