CreateDeviceDistributeJob - IoT Platform - Alibaba Cloud ドキュメントセンター

デバイスを配布するタスクを作成します。デバイスが属するプロダクトはデフォルトで配布されます。

使用方法

デバイスを配布するには、次の手順を実行します。

1. この操作を非同期に呼び出して、デバイス配布タスクを作成し、JobId パラメーターを取得します。

2. JobId をリクエストパラメーターとして使用し、QueryDeviceDistributeJob 操作を繰り返し呼び出して、Status パラメーターを取得します。

説明 QueryDeviceDistributeJob 操作の QPS 制限に基づいて、呼び出しの頻度を制御する必要があります。

Status パラメーターに次のいずれかの値が返された場合、配布タスクは終了します。

2: デバイス配布タスクは完了です。この戻り値は、デバイスが配布されたことを示すものではありません。各デバイスの配布結果を取得するには、次の手順を実行します。
3: 配布が予期せず中断されました。エラーを処理した後、デバイス配布タスクを再度開始できます。

3. 手順 1 で返された JobId をリクエストパラメーターとして使用し、QueryDeviceDistributeDetail 操作を呼び出して、File パラメーターを取得します。 File パラメーターは、配布結果のファイル URL を示します。

説明ファイル URL は 10 分間有効です。

4. ファイル URL を使用して配布結果を取得します。 Code パラメーターは、デバイスが配布されているかどうかを示します。 Code パラメーターの値が 200 の場合、デバイスは配布されています。

配布が失敗した場合、上記の手順を実行してデバイスを再度配布できます。

制限

この操作は、次の エンドポイント を使用してのみ呼び出すことができます: iot.cn-shanghai.aliyuncs.com。
この操作を呼び出して、アカウント間でデバイスを配布することはできません。
Alibaba Cloud アカウントごとに、最大 10 個のプロダクトまたはデバイスを配布するタスクを作成できます。プロダクト配布タスクの作成方法の詳細については、「CreateProductDistributeJob」をご参照ください。
Alibaba Cloud アカウントごとに、1 秒あたり最大 2 クエリ (QPS) を実行できます。
説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	CreateDeviceDistributeJob	実行する操作。値を CreateDeviceDistributeJob に設定します。
DeviceName.N	RepeatList	はい	RepeatList	配布するデバイスの名前。最大 10,000 個のデバイス名を指定できます。
ProductKey	String	はい	a1BwAGV****	デバイスが属するプロダクトの ProductKey。
SourceInstanceId	String	はい	iot-060***	デバイスが属するソースインスタンスの ID。異なるリージョンのパブリックインスタンスの ID: 中国 (上海): iotx-oxssharez200 日本 (東京): iotx-oxssharez300 シンガポール (シンガポール): iotx-oxssharez400 米国 (シリコンバレー): iotx-oxssharez500 米国 (バージニア北部): iotx-oxssharez600 ドイツ (フランクフルト): iotx-oxssharez700 Enterprise Edition インスタンスの ID: 1. IoT Platform コンソールにログインします。上部ナビゲーションバーの左上隅にあるドロップダウンリストからリージョンを選択します。 2. 概要ページで、インスタンス名をクリックします。インスタンスの詳細ページの基本情報セクションでインスタンス ID を確認します。
Strategy	Integer	はい	0	配布ポリシー。デフォルト値: 0。 0: デバイスを指定したリージョンのインスタンスに配布します。 1: 複数のリージョンのインスタンス ID を構成し、デバイスの IP アドレスに基づいてデバイスを最も近いリージョンに配布します。
TargetInstanceConfig.N.TargetInstanceId	String	はい	iot-cn-6ja***	デバイスが配布される宛先インスタンスの構成。インスタンス ID の詳細については、SourceInstanceId パラメーターの説明をご参照ください。 Strategy パラメーターの値が 1 の場合、複数のインスタンス ID を指定できます。 Strategy パラメーターの値が 0 の場合、1 つのインスタンス ID のみ指定できます。
TargetUid	String	いいえ	198***	デバイスが属する Alibaba Cloud アカウントの ID。 IoT Platform コンソールにログインし、プロフィール写真をクリックして、セキュリティ設定ページでアカウント ID を確認できます。 TargetUid パラメーターと TargetAliyunId パラメーターを同時に空にすることはできません。
TargetAliyunId	String	いいえ	io****@example.com	デバイスが属する Alibaba Cloud アカウント。 IoT Platform コンソールにログインし、プロフィール写真をクリックして、セキュリティ設定ページでアカウント ID を確認できます。 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	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateDeviceDistributeJob
&DeviceName.1=RepeatList
&ProductKey=a1BwAGV****
&SourceInstanceId=iot-060***
&Strategy=0
&TargetInstanceConfig.1.TargetInstanceId=iot-cn-6ja***
&TargetAliyunId=io****@example.com
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<CreateDeviceDistributeJobResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <JobId>UbmsMHmkqv0PiAG****010001</JobId>
  <Success>true</Success>
</CreateDeviceDistributeJobResponse>

JSON 形式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "JobId": "UbmsMHmkqv0PiAG****010001",
    "Success": true
}

エラーコード

エラーコードのリストについては、API エラーセンターをご参照ください。