すべてのプロダクト
Search

このプロダクト

    IoT Platform:QueryDeviceDistributeJob

    ドキュメントセンター

    IoT Platform:QueryDeviceDistributeJob

    最終更新日:Apr 17, 2025

    デバイス配布タスクの詳細情報をクエリします。

    使用上の注意

    • この操作は、次の エンドポイント のみを使用して呼び出すことができます: iot.cn-shanghai.aliyuncs.com。
    • Alibaba Cloud アカウントごとに、最大 10 クエリ/秒 (QPS) を実行できます。
      説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

    デバッグ

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

    リクエストパラメーター

    パラメータータイプ必須例説明
    ActionStringはいQueryDeviceDistributeJob

    実行する操作。値を QueryDeviceDistributeJob に設定します。

    JobIdStringはいUbmsMHmkqv0PiAG****010001

    配布タスクの ID。この ID は、タスクをグローバルに識別します。

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

    レスポンスパラメーター

    パラメータータイプ例説明
    CodeStringiot.system.SystemException

    呼び出しが失敗した場合に返されるエラーコード。詳細については、エラーコード を参照してください。

    DataStruct

    呼び出しが成功した場合に返されるタスク情報。

    GmtCreateLong1581595942000

    タスクが作成された時刻。

    JobIdStringUbmsMHmkqv0PiAG****010001

    配布タスクの ID。

    ProductKeyStringa1BwAGV****

    デバイスが属するプロダクトの ProductKey。

    SourceInstanceIdStringiot-cn-6ja***

    ソースインスタンスの ID。

    SourceUidString198***

    Alibaba Cloud アカウントの ID。

    StatusInteger1

    配布タスクのステータス。

    • 0: タスクは初期化中です。
    • 1: タスクは実装中です。
    • 2: タスクは完了しました。このステータスは、配布タスクが完了したことを示すだけで、すべてのプロダクトとデバイスが配布されたことを示すわけではありません。配布結果を取得するには、QueryDeviceDistributeDetail 操作を呼び出します。
    • 3: タスクは予期せず中断されました。
    StrategyInteger0

    配布ポリシー。

    • 0: 指定されたリージョンのインスタンスにデバイスを配布します。
    • 1: 複数のリージョンのインスタンス ID を構成し、デバイスの IP アドレスに基づいてデバイスを最も近いリージョンに配布します。
    TargetInstanceConfigstargetInstanceConfigs の配列

    宛先インスタンスの ID。

    • パラメーターの値が 戦略パラメーターは 1 の場合、複数のインスタンス ID が存在します。
    • 値が 戦略パラメーターは 0 の場合、インスタンス ID は 1 つだけです。
    targetInstanceConfigs
    TargetInstanceIdStringiot-cn-6ja***

    宛先インスタンスの ID。

    TargetUidString198***

    Alibaba Cloud アカウントの ID。

    TotalInteger5

    配布タスクに含まれるデバイスの総数。

    ErrorMessageStringシステム例外が発生しました。

    呼び出しが失敗した場合に返されるエラーメッセージ。

    RequestIdString E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

    リクエストの ID。

    SuccessBooleantrue

    呼び出しが成功したかどうかを示します。

    • true: 呼び出しは成功しました。
    • false: 呼び出しは失敗しました。

    例

    リクエストの例

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

    成功レスポンスの例

    XML 形式

    <QueryDeviceDistributeJobResponse>
  <RequestId> E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Status>1</Status>
        <GmtCreate>1581595942000</GmtCreate>
        <SourceUid>198***</SourceUid>
        <Total>5</Total>
        <Strategy>0</Strategy>
        <TargetUid>198***</TargetUid>
        <SourceInstanceId>iot-cn-6ja***</SourceInstanceId>
        <TargetInstanceConfigs>
              <targetInstanceConfigs>
                    <TargetInstanceId>iot-cn-6ja***</TargetInstanceId>
              </targetInstanceConfigs>
        </TargetInstanceConfigs>
        <ProductKey>a1BwAGV****</ProductKey>
        <JobId>UbmsMHmkqv0PiAG****010001</JobId>
  </Data>
  <Success>true</Success>
</QueryDeviceDistributeJobResponse>

    JSON 形式

    {
    "RequestId": " E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Status": "1",
        "GmtCreate": "1581595942000",
        "SourceUid": "198***",
        "Total": "5",
        "Strategy": "0",
        "TargetUid": "198***",
        "SourceInstanceId": "iot-cn-6ja***",
        "TargetInstanceConfigs": {
            "targetInstanceConfigs": [{
                "TargetInstanceId": "iot-cn-6ja***"
            }]
        },
        "ProductKey": "a1BwAGV****",
        "JobId": "UbmsMHmkqv0PiAG****010001"
    },
    "Success": "true"
}

    エラーコード

    エラーコードの一覧については、API エラーセンター をご覧ください。