すべてのプロダクト
Search

このプロダクト

    IoT Platform:CreateDownloadDataJob

    ドキュメントセンター

    IoT Platform:CreateDownloadDataJob

    最終更新日:Apr 17, 2025

    データダウンロードタスクを作成します。

    使用上の注意

    • CreateDownloadDataJob 操作を呼び出してダウンロードタスクを作成すると、タスクは IoT Platform コンソールに表示されます。対応するテーブルの [エクスポート中] タブで、タスクのログを表示し、必要なファイルをダウンロードできます。

    • CreateDownloadDataJob 操作を呼び出してダウンロードタスクを作成すると、Advanced Message Queuing Protocol (AMQP) を介してプッシュできるメッセージが生成されます。メッセージの consumerGroupId パラメーターを dop_aliyun_group_name に設定します。メッセージの内容には、ダウンロードタスクのステータスが含まれています。 GetDownloadFile 操作を呼び出して、ステータスに基づいて対応するファイルのダウンロードリンクを取得するか、ダウンロードタスクのエラーメッセージを表示できます。

    制限

    • データインスタンスごとに一度に 1 つのダウンロードタスクしか作成できません。ダウンロードタスクは、前のダウンロードタスクが完了した後にのみ作成できます。そうでない場合、ダウンロードタスクの数が制限を超えていることを示すエラーメッセージが表示されます。

    • 過去 3 日間のデータのみダウンロードできます。

    • 1 日に最大 3 つのダウンロードタスクを作成できます。Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

    デバッグ

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

    リクエストパラメーター

    パラメーター

    タイプ

    必須

    例

    説明

    Action

    String

    はい

    CreateDownloadDataJob

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

    IotInstanceId

    String

    いいえ

    iot-cn-npk1u******

    インスタンスの ID。IoT Platform コンソールの 概要 ページでインスタンスの ID を取得できます。

    重要

    • インスタンスに ID がある場合は、このパラメーターを設定する必要があります。そうでない場合、呼び出しは失敗します。

    • IoT Platform コンソールに 概要 ページまたはインスタンス ID が表示されない場合は、このパラメーターを無視します。

    インスタンスの詳細については、「概要」をご参照ください。

    TableName

    String

    はい

    product_info

    ダウンロードするテーブルの名前。

    DownloadDataType

    String

    はい

    TABLE

    ダウンロードするオブジェクトのタイプ。値を TABLE に設定します。

    FileConfig

    Map

    いいえ

    {"fileName":"fileName01"}

    ファイルの設定。fileName フィールドにカスタム名を指定します。fileName フィールドを設定しない場合、ファイル名は自動的に生成されます。

    StartTime

    Long

    いいえ

    1658332800000

    クエリする時間範囲の開始。

    EndTime

    Long

    いいえ

    1658406464534

    クエリする時間範囲の終了。

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

    レスポンスパラメーター

    パラメーター

    タイプ

    例

    説明

    Code

    String

    200

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

    ErrorMessage

    String

    no authorization.

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

    RequestId

    String

    4D6D7F71-1C94-4160-8511-EFF4B8F0643F

    リクエストの ID。

    Success

    Boolean

    true

    呼び出しが成功したかどうかを示します。有効な値：

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

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

    Data

    Object

    返される結果。

    Status

    Integer

    -1

    タスクのステータス。有効な値：

    • -1: タスクは初期化中です。

    • 0: タスクは実行中です。

    • 1: タスクは実行されました。

    • 2: タスクの実行に失敗しました。

    • 3: タスクは送信済みで、実行待ちです。

    • 4: タスクはキャンセルされました。

    LongJobId

    String

    62d949808bc742187xxxxxx

    ダウンロードタスクの ID。

    AsyncExecute

    Boolean

    true

    クエリが非同期かどうかを示します。有効な値：

    • true: クエリは非同期です。

    • false: クエリは同期です。

    CsvUrl

    String

    https://oss-xxxx-xxxx.xxxx......

    Object Storage Service (OSS) バケットに保存されている CSV ファイルのダウンロードリンク。

    CsvFileName

    String

    test_download_file

    ダウンロードされたファイルの名前。

    例

    リクエストの例

    http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateDownloadDataJob
&IotInstanceId=iot-cn-npk1u******
&TableName=product_info
&DownloadDataType=TABLE
&StartTime=1658332800000
&EndTime=1658406464534
&<共通リクエストパラメーター>

    成功レスポンスの例

    XML 形式

    HTTP/1.1 200 OK
Content-Type:application/xml

<CreateDownloadDataJobResponse>
    <code>200</code>
    <data>
        <asyncExecute>true</asyncExecute>
        <longJobId>62d949808bc742187xxxxxx</longJobId>
        <resultDataInString/>
        <status>-1</status>
    </data>
    <requestId>C8E9E92F-ADD1-1434-BA90-E85F70F5C536</requestId>
    <success>true</success>
</CreateDownloadDataJobResponse>

    JSON 形式

    HTTP/1.1 200 OK
Content-Type:application/json

{
  "code" : "200",
  "data" : {
    "asyncExecute" : true,
    "longJobId" : "62d949808bc742187xxxxxx",
    "resultDataInString" : "",
    "status" : -1
  },
  "requestId" : "C8E9E92F-ADD1-1434-BA90-E85F70F5C536",
  "success" : true
}

    エラーコード

    HttpCode

    エラーコード

    エラーメッセージ

    説明

    400

    iot.dap.insight.noAuthorization

    no authorization.

    操作を実行する権限がありません。

    400

    iot.dap.insight.requestParamError

    request param error.

    指定されたリクエストパラメーターが無効です。

    400

    iot.dap.insight.serverError

    server hsf error please try later

    バックエンドの High-speed Service Framework (HSF) サービスでエラーが発生しました。後でもう一度お試しください。

    400

    iot.dap.insight.queryTimeMoreThanQueryDays

    The query time range exceeded the allowed time range

    クエリする時間範囲が無効です。

    400

    iot.dap.insight.processDownloadJobMoreConcurrenceCount

    the number of concurrent download tasks in progress exceeds the upper limit

    同時に実行されているダウンロードタスクの数が制限を超えています。

    400

    iot.dap.insight.downloadTimesUpperLimit

    the number of current job downloaded tasks exceeded the upper limit

    現在の日付のダウンロードタスクのダウンロード数が制限を超えています。

    400

    iot.dap.insight.downloadTaskNumUpperLimit

    the number of downloaded tasks exceeded the upper limit

    現在の日付に実行されたダウンロードタスクの数が制限を超えています。

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