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

デバイス分散タスクをクエリします。

使用上の注意

Enterprise Edition インスタンスを使用する場合は、この操作を呼び出すときに IotInstanceId パラメーターを指定する必要があります。指定しないと、呼び出しは失敗します。

QPS 制限

この API 操作は、アカウントごとに 1 秒あたり最大 5 回呼び出すことができます。

説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	ListDeviceDistributeJob	実行する操作。値を ListDeviceDistributeJob に設定します。
PageSize	Integer	Yes	10	各ページに戻されるエントリの数。有効な値：1 ～ 200。
TargetUid	String	No	198***	デバイスの配布先となる Alibaba Cloud アカウントの ID。
CurrentPage	Integer	No	1	返すページ番号。デフォルト値：1。 NextToken パラメーターまたは CurrentPage パラメーターは、結果を表示するための条件を指定します。2つのパラメーターのいずれかを指定できます。両方のパラメーターを同時に指定した場合、NextToken パラメーターが使用されます。 NextToken パラメーターの詳細については、NextToken パラメーターの説明をご参照ください。
Status	Integer	No	1	デバイス分散タスクのステータス。 0: タスクは初期化中です。 1: タスクは実行中です。 2: タスクは完了しました。このステータスは、分散タスクが完了したことを示しますが、すべての製品とデバイスが分散されたことを示すものではありません。分散結果を取得するには、QueryDeviceDistributeDetail 操作を呼び出します。 3: タスクは予期せず中断されました。
JobId	String	No	UbmsMHmkqv0PiAG****010001	分散タスクの ID。この ID はグローバルに一意です。
NextToken	String	No	TGlzdFJlc291***	クエリ結果の次のページを取得するために使用されるトークン。クエリ操作を初めて実行するときは、このパラメーターを指定する必要はありません。 NextToken パラメーターまたは CurrentPage パラメーターは、結果を表示するための条件を指定します。2 つのパラメーターのいずれかを指定できます。両方のパラメーターを同時に指定した場合、NextToken パラメーターが使用されます。重要結果の数のオフセットは、次の式を使用して取得されます：PageSize × (CurrentPage - 1)。オフセットが 10,000 を超える場合は、Data パラメーターの値を取得するために、前のクエリで返されたトークンを NextToken パラメーターの値として使用する必要があります。そうしないと、現在のリクエストは終了し、Data パラメーターの値は返されません。
ProductKey	String	No	aw3zse****	デバイスが属する製品の ProductKey。

上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返される分散タスク。詳細については、JobInfo パラメーターをご参照ください。
JobInfo	Array of items		タスクに関する情報。
items
GmtCreate	Long	1581595942000	タスクが作成された時刻。
JobId	String	UbmsMHmkqv0PiAG****010001	タスクの ID。
ProductKey	String	a1BwAGV****	デバイスが属する製品の ProductKey。
SourceInstanceId	String	iot-cn-6ja***	ソースインスタンスの ID。
SourceInstanceName	String	Instance Debug 1	ソースインスタンスの名前。
SourceRegion	String	cn-shanghai	ソースインスタンスが存在するリージョン。
SourceUid	String	198***	ソース Alibaba Cloud アカウントの ID。
Status	Integer	1	タスクのステータス。 0: タスクは初期化中です。 1: タスクは実行中です。 2: タスクは完了しました。このステータスは、分散タスクが完了したことを示しますが、すべての製品とデバイスが分散されたことを示すものではありません。分散結果を取得するには、QueryDeviceDistributeDetail 操作を呼び出します。 3: タスクは予期せず中断されました。
Strategy	Integer	0	分散ポリシー。 0: デバイスを指定されたリージョンの指定されたインスタンスに分散します。これがデフォルト値です。 1: 複数のリージョンでインスタンス ID を構成し、デバイスの IP アドレスに基づいてデバイスを最も近いリージョンに分散します。
TargetInstanceConfigs	Array of targetInstanceConfigs		宛先インスタンスの ID。 Strategy パラメーターの値が 1 の場合、複数のインスタンス ID が存在します。 Strategy パラメーターの値が 0 の場合、インスタンス ID は 1 つだけです。
targetInstanceConfigs
TargetInstanceId	String	iot-cn-6ja***	宛先インスタンスの ID。
TargetInstanceName	String	Instance Debug 2	宛先インスタンスの名前。
TargetRegion	String	cn-shanghai	宛先インスタンスが存在するリージョン。
TargetUid	String	198***	宛先 Alibaba Cloud アカウントの ID。
Total	Integer	5	分散タスク内のデバイスの総数。
NextToken	String	TGlzdFJlc291***	クエリ結果の次のページを取得するために使用されるトークン。このパラメーターの値は、次のクエリで使用して、結果の次のページを取得できます。戻り値が空の場合、次のページは存在しません。
Total	Integer	10	デバイス分散タスクの総数。
ErrorMessage	String	A system exception occurred.	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。有効な値： true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListDeviceDistributeJob
&CurrentPage=1
&PageSize=10
&TargetUid=198***
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<ListDeviceDistributeJobResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <NextToken>TGlzdFJlc291***</NextToken>
        <Total>10</Total>
        <JobInfo>
              <items>
                    <Status>1</Status>
                    <SourceInstanceName> Instance Debug 1</SourceInstanceName>
                    <GmtCreate>1581595942000</GmtCreate>
                    <SourceUid>198***</SourceUid>
                    <Total>5</Total>
                    <Strategy>0</Strategy>
                    <TargetUid>198***</TargetUid>
                    <SourceRegion>cn-shanghai</SourceRegion>
                    <SourceInstanceId>iot-cn-6ja***</SourceInstanceId>
                    <ProductKey>a1BwAGV****</ProductKey>
                    <JobId>UbmsMHmkqv0PiAG****010001</JobId>
                    <TargetInstanceConfigs>
                          <targetInstanceConfigs>
                                <TargetRegion>cn-shanghai</TargetRegion>
                                <TargetInstanceName> Instance Debug 2</TargetInstanceName>
                                <TargetInstanceId>iot-cn-6ja***</TargetInstanceId>
                          </targetInstanceConfigs>
                    </TargetInstanceConfigs>
              </items>
        </JobInfo>
  </Data>
  <Success>true</Success>
</ListDeviceDistributeJobResponse>

JSON 形式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "NextToken":"TGlzdFJlc291***",
        "Total": 10,
        "JobInfo": {
            "items": {
                "Status": 1,
                "SourceInstanceName": "Instance Debug 1",
                "GmtCreate": 1581595942000,
                "SourceUid": "198***",
                "Total": 5,
                "Strategy": 0,
                "TargetUid": "198***",
                "SourceRegion": "cn-shanghai",
                "SourceInstanceId": "iot-cn-6ja***",
                "ProductKey": "a1BwAGV****",
                "JobId": "UbmsMHmkqv0PiAG****010001",
                "TargetInstanceConfigs": {
                    "targetInstanceConfigs": {
                        "TargetRegion": "cn-shanghai",
                        "TargetInstanceName": "Instance Debug 2",
                        "TargetInstanceId": "iot-cn-6ja***"
                    }
                }
            }
        }
    },
    "Success": true
}

エラーコード

エラーコードの一覧については、「サービスエラーコード」をご参照ください。