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

タスクまたはデバイスのサブタスクをクエリします。

QPS 制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	ListTask	実行する操作。値を ListTask に設定します。
Limit	Integer	Yes	10	1 ページあたりのエントリ数。デフォルト値：10。最大値：50。
IotInstanceId	String	No	iot-cn-0pp1n8t****	インスタンスの ID。IoT Platform コンソールの [概要] タブでインスタンスの ID を表示できます。重要インスタンスに ID がある場合は、このパラメーターを指定する必要があります。指定しないと、呼び出しは失敗します。インスタンスに対して [概要] タブまたは ID が生成されていない場合は、このパラメーターを指定する必要はありません。インスタンスの詳細については、「概要」をご参照ください。
JobId	String	No	sGWotgRk***010001	タスクの ID。この ID はグローバルに一意です。説明 Device を指定する場合は、このパラメーターを指定しないでください。
NextToken	String	No	22dhgg***	次のリクエストで使用されるページネーショントークン。新しいページの結果を取得するために使用します。最初のリクエストでは、このパラメーターを指定する必要はありません。前のクエリから取得したトークンを NextToken の値として指定する必要があります。 NextToken の値は 1 分間有効です。トークンの有効期限が切れると、エラーコードが返されます。
Device	Json	No	{}	デバイスの詳細。詳細については、このトピックの「デバイス定義」セクションをご参照ください。説明 JobId を指定する場合は、このパラメーターを指定しないでください。
Status	String	No	QUEUED	サブタスクのステータス。デフォルト値：1。有効な値： QUEUED：サブタスクはスケジュール待ちです。 SENT：サブタスクはスケジュールされています。 IN_PROGRESS：サブタスクは実行中です。 FAILED：サブタスクは失敗しました。 REJECTED：サブタスクは拒否されました。 TIMED_OUT：サブタスクはタイムアウトしました。 SUCCEEDED：サブタスクは成功しました。 CANCELLED：サブタスクはキャンセルされました。

デバイス定義

パラメーター	タイプ	説明
IotId	String	デバイスの ID。 IotId、ProductKey、 DeviceName は同時には空にできません。
ProductKey	String	デバイスが属するプロダクトの ProductKey。このパラメーターを指定する場合は、DeviceName も指定する必要があります。
DeviceName	String	デバイスの DeviceName。このパラメーターを指定する場合は、ProductKey も指定する必要があります。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	データの配列		呼び出しが成功した場合に返されるサブタスクの詳細。詳細については、以下のパラメーターをご参照ください。
data
DeviceName	String	mydevice	デバイスの DeviceName。
IotId	String	BDjhIC***i000101	デバイスの ID。この ID は、IoT Platform がデバイスに発行する一意の識別子です。
JobId	String	sGWotg***010001	タスクの ID。この ID はグローバルに一意です。
JobName	String	MyTestJobIax6Eq	タスクの名前。
ProductKey	String	a1S0OM***	デバイスが属するプロダクトの ProductKey。
Progress	String	80	サブタスクの進捗状況。
Status	String	SUCCEEDED	サブタスクのステータス。 QUEUED：サブタスクはスケジュール待ちです。 SENT：サブタスクはスケジュールされています。 IN_PROGRESS：サブタスクは実行中です。 FAILED：サブタスクは失敗しました。 REJECTED：サブタスクは拒否されました。 TIMED_OUT：サブタスクはタイムアウトしました。 SUCCEEDED：サブタスクは成功しました。 CANCELLED：サブタスクはキャンセルされました。
TaskId	String	MSnT9wl***q010101	サブタスクの ID。この ID は、サブタスクをグローバルに識別します。
UtcModified	String	2019-05-21T13:03:56.000Z	サブタスクが最後に変更された日時。
UtcQueueTime	String	2019-05-21T13:03:53.000Z	サブタスクがキューに入れられていた期間。
ErrorMessage	String	A system exception occurred.	呼び出しが失敗した場合に返されるエラーメッセージ。
NextToken	String	223sdf***	ページネーショントークン。次のリクエストで新しいページの結果を取得するために使用できます。最初のリクエストでは、このパラメーターを指定する必要はありません。前のクエリから取得したトークンを NextPageToken の値として指定する必要があります。 NextToken の値は 1 分間有効です。トークンの有効期限が切れると、エラーコードが返されます。
RequestId	String	512FF8FD-A97F-4AAF-B0A2-7BE3D3A19BB3	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。有効な値： true：呼び出しは成功しました。 false：呼び出しは失敗しました。

例

リクエストの例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListTask
&Limit=10
&JobId=XUbmsMHmkqv0PiAG****010001
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<ListTaskResponse>
  <NextToken>223sdf***</NextToken>
  <RequestId>512FF8FD-A97F-4AAF-B0A2-7BE3D3A19BB3</RequestId>
  <Data>
        <data>
              <Status>SUCCEEDED</Status>
              <IotId>BDjhIC***i000101</IotId>
              <Progress>80</Progress>
              <TaskId>MSnT9wl***q010101</TaskId>
              <JobName>MyTestJobIax6Eq</JobName>
              <UtcModified>2019-05-21T13:03:56.000Z</UtcModified>
              <UtcQueueTime>2019-05-21T13:03:53.000Z</UtcQueueTime>
              <ProductKey>a1S0OM***</ProductKey>
              <JobId>sGWotg***010001</JobId>
              <DeviceName>mydevice</DeviceName>
        </data>
  </Data>
  <Success>true</Success>
</ListTaskResponse>

JSON 形式

{
    "NextToken": "223sdf***",
    "RequestId": "512FF8FD-A97F-4AAF-B0A2-7BE3D3A19BB3",
    "Data": {
        "data": {
            "Status": "SUCCEEDED",
            "IotId": "BDjhIC***i000101",
            "Progress": 80,
            "TaskId": "MSnT9wl***q010101",
            "JobName": "MyTestJobIax6Eq",
            "UtcModified": "2019-05-21T13:03:56.000Z",
            "UtcQueueTime": "2019-05-21T13:03:53.000Z",
            "ProductKey": "a1S0OM***",
            "JobId": "sGWotg***010001",
            "DeviceName": "mydevice"
        }
    },
    "Success": true
}

エラーコード

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