IoT Platform:GetDownloadFile

パラメータ

タイプ

必須

例

説明

Action

String

はい

GetDownloadFile

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

Context

Map

いいえ

{"xxx";xxx}

リクエストのコンテンツ。

IotInstanceId

String

いいえ

iot-cn-npk1u******

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

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

LongJobId

String

はい

62d949808bc742187xxxxxx

ダウンロードタスクの作成時に返されるタスク ID です。詳細については、「CreateDownloadDataJob」パラメーターの CreateDownloadDataJob 操作をご参照ください。

パラメータ

タイプ

例

説明

Code

String

200

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

ErrorMessage

String

no authorization.

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

RequestId

String

BB71E443-4447-4024-A000-EDE09934****

リクエストの ID。

Success

Boolean

true

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

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

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

Data

Object

返されるデータ。

Status

Integer

1

ダウンロードタスクのステータス。有効な値：

• -1: ダウンロードタスクは初期化中です。

• 0: ダウンロードタスクは実行中です。

• 1: ダウンロードタスクは実行されました。

• 2: ダウンロードタスクの実行に失敗しました。

• 3: ダウンロードタスクは送信済みで、実行待ちです。

• 4: ダウンロードタスクはキャンセルされました。

LongJobId

String

62d949808bc742187xxxxxx

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

BeginTime

Long

1658406464534

ダウンロードタスクが開始された時刻。

AsyncExecute

Boolean

true

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

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

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

TotalCount

Long

100

返されるエントリの総数。

EndTime

Long

1658406465000

ダウンロードタスクが終了した時刻。

PreviewSize

Integer

100

プレビューページあたりのエントリ数。

PageNo

Integer

1

ページ番号。

PageSize

Integer

10

ページあたりのエントリ数。

CsvUrl

String

https://xxxxx-data-download-sh.oss-cn-shanghai.aliyuncs.com/data/download/6B761BxxxxxxxxAAA0BF03D32C80E/62da39b9xxxxxx5a7b953376/download_file_name.csv?Expires=1658469132&OSSAccessKeyId=xxxxxxxxx&Signature=rRL%xxxxxxx%3D

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

CsvFileName

String

test_download_flie

CSV ファイルの名前

DatasetId

String

xxxxxx

ダウンロードされたオブジェクトの ID。

ResultDataInString

String

{"a":123}

クエリの結果。

Header

Header の配列

返されるフィールドの詳細。

TypeClass

String

date

タイプのディメンション。

FieldName

String

user_name

フィールドの名前。

GeoClass

String

{xxx:xxxx}

地理情報。

FieldType

String

INTEGER

フィールドのタイプ。

TimeClass

String

HOUR/DAY/MONTH

時間のディメンション。

DimDateClass

String

DAY

スケジュールタイプ。

Alias

String

user_name_alias

フィールドのエイリアス。

Result

Object の配列

{"a":123}

QuerySetting

Object

クエリ詳細。

SelectedHeaders

SelectedHeaders の配列

クエリ対象のフィールド。

FieldName

String

user_name

フィールドの名前。

GeoClass

String

{xxx:xxx}

地理情報。

FieldType

String

INTEGER

フィールドのタイプ。

TimeClass

String

HOUR/DAY/MONTH

日付ディメンション。

Alias

String

user_name_alias

フィールドのエイリアス。

DimDateClass

String

DAY

スケジュールタイプ。

AstExpr

AstExpr の配列

クエリ条件。

ExprType

String

binaryOp

式のタイプ。

Expr

String

{"header":{"fieldName":"xxx"},"operator":"GreaterThanOrEqual","value":12345}

式のコンテンツ。

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.downloadTaskNumUpperLimit

the number of downloaded tasks exceeded the upper limit

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

400

iot.dap.insight.downloadTimesUpperLimit

the number of current job downloaded tasks exceeded the upper limit

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