ダウンロードタスクに関する情報を取得します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
GET /downloadjobs/{downloadJobName} HTTP/1.1
パスパラメータ
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| downloadJobName |
string |
必須 |
ログダウンロードタスクの名前です。 |
download-123 |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
リクエストパラメーターは必要ありません。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
ダウンロードジョブに関する情報です。 |
||
| status |
string |
ダウンロードタスクのステータスです。 |
STARTING、RUNNING、SUCCEEDED、ERROR |
| name |
string |
ダウンロードタスクの名前です。 |
download-123 |
| description |
string |
タスクの説明です。 |
a download job |
| configuration |
object |
ダウンロード構成です。 |
|
| logstore |
string |
ソース Logstore です。 |
ali-test-logstore |
| fromTime |
integer |
ダウンロードタスクの開始時刻です。値は秒単位の UNIX タイムスタンプです。 |
1722409860 |
| toTime |
integer |
ダウンロードタスクの終了時刻です。値は秒単位の UNIX タイムスタンプです。 |
1722411060 |
| query |
string |
検索文です。 |
* | select * |
| powerSql |
boolean |
PowerSQL を有効にするかどうかを指定します。 |
false |
| allowInComplete |
boolean |
不完全なデータのダウンロードを許可するかどうかを指定します。 列挙値:
|
true |
| sink |
object |
エクスポート構成です。 |
|
| type |
string |
値は AliyunOSS に固定されています。 |
AliyunOSS |
| contentType |
string |
ファイル形式です。 |
csv |
| compressionType |
string |
圧縮フォーマットです。 |
none |
| roleArn |
string |
ダウンロードに使用される RAM ロールの Alibaba Cloud リソースネーム (ARN) です。 |
acs:ram::0123456789:role/aliyunlogdefaultrole |
| bucket |
string |
Object Storage Service (OSS) バケットです。 |
ali-test-oss-bucket |
| prefix |
string |
バケットに保存されるファイルのプレフィックスです。 |
download/ |
| createTime |
string |
タスクが作成された時刻です。 |
1722411060 |
| displayName |
string |
表示名です。 |
download-123456 |
| executionDetails |
object |
実行の詳細です。 |
|
| progress |
integer |
ダウンロードの進行状況です。 |
100 |
| filePath |
string |
ダウンロード結果の URL です。 |
https://xxx.csv.zst?xxx |
| fileSize |
integer |
ダウンロードされたファイルのサイズ (バイト単位) です。 |
123456 |
| executeTime |
integer |
ダウンロードタスクの期間 (秒単位) です。 |
123 |
| logCount |
integer |
ダウンロードされたログエントリの数です。 |
123 |
| errorMessage |
string |
ダウンロードが失敗した場合のエラーメッセージです。 |
timeout |
| checkSum |
string |
ファイルの ETag です。 |
EXSFGSDASDASDG123ASD |
| notice |
string |
例
成功レスポンス
JSONJSON
{
"status": "STARTING、RUNNING、SUCCEEDED、ERROR",
"name": "download-123",
"description": "a download job",
"configuration": {
"logstore": "ali-test-logstore",
"fromTime": 1722409860,
"toTime": 1722411060,
"query": "* | select *",
"powerSql": false,
"allowInComplete": true,
"sink": {
"type": "AliyunOSS",
"contentType": "csv",
"compressionType": "none",
"roleArn": "acs:ram::0123456789:role/aliyunlogdefaultrole",
"bucket": "ali-test-oss-bucket",
"prefix": "download/"
}
},
"createTime": "1722411060",
"displayName": "download-123456",
"executionDetails": {
"progress": 100,
"filePath": "https://xxx.csv.zst?xxx",
"fileSize": 123456,
"executeTime": 123,
"logCount": 123,
"errorMessage": "timeout",
"checkSum": "EXSFGSDASDASDG123ASD",
"notice": ""
}
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。