クエリジョブ - IoT Platform - Alibaba Cloud ドキュメントセンター

タスクの詳細をクエリします。

QPS 制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	QueryJob	実行する操作。値を QueryJob に設定します。
JobId	String	Yes	450407b***	タスクの ID。ID はグローバルに一意です。
IotInstanceId	String	No	iot-cn-0pp1n8t****	インスタンスの ID。IoT Platform コンソールの [概要] タブでインスタンスの ID を表示できます。重要インスタンスに ID がある場合は、パラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。インスタンスに対して [概要] タブまたは ID が生成されていない場合は、このパラメーターを指定する必要はありません。インスタンスの詳細については、「概要」をご参照ください。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返されるタスクの詳細。詳細については、以下のパラメーターをご参照ください。
Description	String	jobDescription	タスクの説明。
JobDocument	String	{ "serviceIdentifier": "test_service", "params": { "key1": "value1", "key2": "value2" } }	デバイスに発行するルールファイル。
JobFile	Struct		ファイルのダウンロード情報。
FileUrl	String	https://iotx-*.oss-cn-shanghai.aliyuncs.com/job/7u.sh?Expires=16&OSSAccessKeyId=LTA&Signature=TTTejn*	ファイルのダウンロード URL。ダウンロード URL は 30 分間有効です。
Sign	String	TTTejn***	署名。URL を使用してアップロードされたファイルの場合、署名は署名メソッドに基づいて生成されます。
SignMethod	String	SHA256	署名メソッド。有効な値：MD5 および SHA256。
JobId	String	450407b***	タスクの ID。ID はグローバルに一意です。
JobName	String	tes	タスクの名前。
RolloutConfig	Struct		タスク内のサブタスクのプッシュレート。
MaximumPerMinute	Integer	10	タスクで 1 分あたりにプッシュするサブタスクの数。
MessageQoS	String	Qos1	メッセージのサービス品質（QoS）レベル。このパラメーターは、カスタムタスクとバッチメッセージ配信タスクでのみ使用できます。有効な値： QoS0：システムはメッセージを 1 回だけ送信します。 QoS1：システムはメッセージを少なくとも 1 回送信します。QoS 1 メッセージを送信した後に PUBACK 応答が返されない場合、デバイスが IoT Platform に再接続すると、メッセージがデバイスに再度プッシュされます。
ScheduledTime	Long	1557062301656	タスクがスケジュールされた時刻。単位：ミリ秒。
Status	String	CANCELLED	タスクのステータス。有効な値： INITIALIZING：タスクは初期化中です。 WAITING：タスクはスケジュール待ちです。 IN_PROGRESS：タスクは進行中です。 COMPLETE：タスクは完了しました。 CANCELLING: タスクはキャンセル中です。 CANCELLED：タスクはキャンセルされました。 REMOVING：タスクは削除中です。 TIMED_OUT：タスクはタイムアウトしました。
TargetConfig	Struct		タスクが実装されているデバイスの構成。
TargetDevices	Array of targetDevices		デバイス
targetDevices
DeviceName	String	a1Ix***	デバイスの DeviceName。
ProductKey	String	nCwfSBzc***	デバイスが属するプロダクトの ProductKey。
TargetGroup	String	1234	デバイスが属するデバイスグループの ID。
TargetProduct	String	nCwfSBzc***	デバイスが属するプロダクトの ProductKey。
TargetType	String	DEVICE_LIST	デバイスの構成タイプ。有効な値： DEVICE_LIST：デバイスのリスト GROUP_ID：デバイスグループの ID PRODUCT_KEY：プロダクトの ProductKey
TimeoutConfig	Struct		タスク内のサブタスクのタイムアウト構成。
InProgressTimeoutInMinutes	Integer	5	サブタスクのタイムアウト期間。単位：分。
Type	String	SET_PROPERTY	タスクのタイプ。有効な値： INVOKE_SERVICE：バッチサービス呼び出しタスク。 SET_PROPERTY：バッチプロパティ構成タスク。 PUB：バッチメッセージ配信タスク。 CUSTOM_JOB：カスタムタスク。
UtcCreate	String	2020-12-13T04:09:51.000Z	タスクが作成された時刻。
UtcModified	String	2020-12-13T04:10:00.000Z	タスクが最後に変更された時刻。
ErrorMessage	String	A system exception occurred.	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	A6BEAB33-03E6-4CE0-A94F-9E24C5512BAD	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。有効な値： true：呼び出しは成功しました。 false：呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryJob
&JobId=XUbmsMHmkqv0PiAG****010001
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<QueryJobResponse>
    <RequestId>A6BEAB33-03E6-4CE0-A94F-9E24C5512BAD</RequestId>
    <Data>
            <Status>CANCELLED</Status>
		    <ScheduledTime>1557062301656</ScheduledTime>
            <Type>SET_PROPERTY</Type>
            <TimeoutConfig>
                    <InProgressTimeoutInMinutes>5</InProgressTimeoutInMinutes>
            </TimeoutConfig>
            <Description>jobDescription</Description>
            <UtcCreate>2020-12-13T04:09:51.000Z</UtcCreate>
            <JobFile>
                    <FileUrl>https://iotx-***.oss-cn-shanghai.aliyuncs.com/job***/7u***.sh?Expires=16***&amp;OSSAccessKeyId=LTA***&amp;Signature=TTTejn***</FileUrl>
                    <Sign>1235</Sign>
                    <SignMethod>SHA256</SignMethod>
            </JobFile>
            <JobDocument>{}</JobDocument>
            <JobName>test</JobName>
            <UtcModified>2020-12-13T04:10:00.000Z</UtcModified>
            <JobId>450407b***</JobId>
            <TargetConfig>
                    <TargetDevices>
                            <targetDevices>
                                    <ProductKey>nCwf***</ProductKey>
                                    <DeviceName>a1IxS***</DeviceName>
                            </targetDevices>
                            <targetDevices>
                                    <ProductKey>24VI***</ProductKey>
                                    <DeviceName>a1***</DeviceName>
                            </targetDevices>
                            <targetDevices>
                                    <ProductKey>6NDWQ***</ProductKey>
                                    <DeviceName>a1I***</DeviceName>
                            </targetDevices>
                            <targetDevices>
                                    <ProductKey>EQtTJT***</ProductKey>
                                    <DeviceName>a1IxS***</DeviceName>
                            </targetDevices>
                            <targetDevices>
                                    <ProductKey>rUdc33Vr***</ProductKey>
                                    <DeviceName>a1IxS***</DeviceName>
                            </targetDevices>
                    </TargetDevices>
                    <TargetType>DEVICE_LIST</TargetType>
            </TargetConfig>
    </Data>
    <Success>true</Success>
</QueryJobResponse>

JSON 形式

{
    "RequestId": "A6BEAB33-03E6-4CE0-A94F-9E24C5512BAD",
    "Data": {
        "Status": "CANCELLED",
        "ScheduledTime": 1557062301656,
        "Type": "SET_PROPERTY",
        "TimeoutConfig": {
            "InProgressTimeoutInMinutes": 5
        },
        "Description": "jobDescription",
        "UtcCreate": "2020-12-13T04:09:51.000Z",
        "JobFile": {
            "FileUrl": "https://iotx-***.oss-cn-shanghai.aliyuncs.com/job***/7u***.sh?Expires=16***&amp;OSSAccessKeyId=LTA***&amp;Signature=TTTejn***",
            "Sign": "1235",
            "SignMethod": "SHA256"
        },
        "JobDocument": "{}",
        "JobName": "test",
        "UtcModified": "2020-12-13T04:10:00.000Z",
        "JobId": "450407b***",
        "TargetConfig": {
            "TargetDevices": {
                "targetDevices": [
                    {
                        "ProductKey": "nCwf***",
                        "DeviceName": "a1IxS***"
                    },
                    {
                        "ProductKey": "24VI***",
                        "DeviceName": "a1***"
                    },
                    {
                        "ProductKey": "6NDWQ***",
                        "DeviceName": "a1I***"
                    },
                    {
                        "ProductKey": "EQtTJT***",
                        "DeviceName": "a1IxS***"
                    },
                    {
                        "ProductKey": "rUdc33Vr***",
                        "DeviceName": "a1IxS***"
                    }
                ]
            },
            "TargetType": "DEVICE_LIST"
        }
    },
    "Success": true
}

エラーコード

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