すべてのプロダクト
Search
ドキュメントセンター

Simple Log Service:ListDownloadJobs

最終更新日:Jan 26, 2026

指定されたプロジェクト内のログダウンロードジョブを一覧表示します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

log:ListDownloadJobs

list

*All Resource

*

なし なし

リクエスト構文

GET /downloadjobs HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

project

string

必須

プロジェクトの名前。

ali-test-project

offset

integer

任意

クエリを開始する行。デフォルト値は 0 です。

0

size

integer

任意

1 回のリクエストで返されるログダウンロードジョブの数。

10

logstore

string

任意

Logstore の名前。

ali-test-logstore

レスポンスフィールド

フィールド

説明

object

すべてのログダウンロードジョブに関する情報。

total

integer

レコードの総数。

10

count

integer

現在の応答で返されたログダウンロードジョブの数。

10

results

array<object>

ログダウンロードジョブのリストを含む配列。

array<object>

ログダウンロードジョブに関する情報。

description

string

ログダウンロードジョブの説明。

a download job

configuration

object

ダウンロード構成。

logstore

string

ソース Logstore。

ali-test-logstore

fromTime

integer

クエリの開始時刻。これは、秒単位の UNIX タイムスタンプです。

1722409260

toTime

integer

クエリの終了時刻。これは、秒単位の UNIX タイムスタンプです。

1722411060

query

string

クエリ文。

* | select *

powerSql

boolean

PowerSQL を有効にするかどうかを指定します。

true

allowInComplete

string

不完全な結果のダウンロードを許可するかどうかを指定します。

false

sink

object

シンク構成。

compressionType

string

圧縮形式。

none

contentType

string

ダウンロードされたファイルのファイル形式。

csv

roleArn

string

ダウンロードに使用される RAM ロールの Alibaba Cloud リソース名 (ARN)。

acs:ram::123456:role/aliyunlogimportossrole

bucket

string

宛先の OSS バケット。

ali-test-oss-bucket

prefix

string

宛先の OSS バケットにダウンロードされるオブジェクトのプレフィックス。

download/

type

string

シンクのタイプ。値は AliyunOSS に固定されています。

AliyunOSS

displayName

string

表示名

download-123

executionDetails

object

ジョブの実行詳細。

progress

integer

ダウンロードの進捗状況 (パーセンテージ)。

100

filePath

string

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

https://sls-downloaded-xxxx.csv.gzip?Expiresxxx

fileSize

integer

ダウンロードされたファイルのサイズ (バイト単位)。

123456

executeTime

integer

ダウンロードの実行時間。

123

logCount

integer

ダウンロードされたログエントリの数。

123

errorMessage

string

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

timeout

checkSum

string

ファイルの ETag。

ETASFGASDASQWDasd

notice

string

通知メッセージ。

test

name

string

ログダウンロードジョブの名前。

download-123

createTime

string

ログダウンロードジョブが作成された時刻。これは、秒単位の UNIX タイムスタンプです。

1722411060

status

string

ジョブのステータス。

STARTING、RUNNING、SUCCEEDED、ERROR

成功レスポンス

JSONJSON

{
  "total": 10,
  "count": 10,
  "results": [
    {
      "description": "a download job",
      "configuration": {
        "logstore": "ali-test-logstore",
        "fromTime": 1722409260,
        "toTime": 1722411060,
        "query": "* | select *",
        "powerSql": true,
        "allowInComplete": "false",
        "sink": {
          "compressionType": "none",
          "contentType": "csv",
          "roleArn": "acs:ram::123456:role/aliyunlogimportossrole",
          "bucket": "ali-test-oss-bucket",
          "prefix": "download/",
          "type": "AliyunOSS"
        }
      },
      "displayName": "download-123",
      "executionDetails": {
        "progress": 100,
        "filePath": "https://sls-downloaded-xxxx.csv.gzip?Expiresxxx",
        "fileSize": 123456,
        "executeTime": 123,
        "logCount": 123,
        "errorMessage": "timeout",
        "checkSum": "ETASFGASDASQWDasd",
        "notice": "test"
      },
      "name": "download-123",
      "createTime": "1722411060",
      "status": "STARTING、RUNNING、SUCCEEDED、ERROR"
    }
  ]
}

エラーコード

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

変更履歴

完全なリストについては、「変更履歴」をご参照ください。