Referensi API GetDownloadJob untuk Pekerjaan Unduhan Log - Simple Log Service - Alibaba Cloud - Simple Log Service

Mengambil informasi tentang tugas unduhan log.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

log:GetDownloadJob

get

*Project

acs:log:{#regionId}:{#accountId}:project/{#project}/downloadjob/{#downloadJobName}

None

Sintaks permintaan

GET /downloadjobs/{downloadJobName} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
downloadJobName	string	Yes	Nama tugas unduhan log.	download-123

Parameter permintaan

Parameter	Type	Required	Description	Example
project	string	Yes	Nama proyek.	Proyek

Elemen respons

Element	Type	Description	Example
	object	Informasi pekerjaan unduhan.
status	string	Status tugas unduhan.	STARTING、RUNNING、SUCCEEDED、ERROR
name	string	Nama tugas unduhan.	download-123
description	string	Deskripsi.	tugas unduhan
configuration	object	Konfigurasi unduhan.
logstore	string	Penyimpanan log sumber.	ali-test-logstore
fromTime	integer	Stempel waktu mulai, dalam detik.	1722409860
toTime	integer	Stempel waktu selesai, dalam detik.	1722411060
query	string	Pernyataan kueri.	* \| select *
powerSql	boolean	Apakah PowerSQL diaktifkan.	false
allowInComplete	boolean	Apakah akan mengizinkan pengunduhan data yang tidak lengkap. Valid values: true : true. false : false.	true
sink	object	Konfigurasi ekspor.
type	string	Nilai tetap: AliyunOSS.	AliyunOSS
contentType	string	Format file yang diunduh.	csv
compressionType	string	Format kompresi.	none
roleArn	string	ARN peran RAM yang digunakan untuk unduhan.	acs:ram::0123456789:peran/aliyunlogdefaultrole
bucket	string	Bucket OSS.	ali-test-oss-bucket
prefix	string	Awalan file yang digunakan saat mengunduh log ke bucket OSS pengguna.	download/
createTime	string	Waktu pembuatan.	1722411060
displayName	string	Nama tampilan.	download-123456
executionDetails	object	Detail eksekusi.
progress	integer	Progres unduhan.	100
filePath	string	Tautan hasil unduhan.	https://xxx.csv.zst?xxx
fileSize	integer	Ukuran file yang diunduh.	123456
executeTime	integer	Waktu eksekusi unduhan.	123
logCount	integer	Jumlah entri log yang diunduh.	123
errorMessage	string	Pesan error unduhan.	pengatur waktu
checkSum	string	ETag file.	EXSFGSDASDASDG123ASD
notice	string	Teks notifikasi.	test

Contoh

Respons sukses

JSONformat

{
  "status": "STARTING、RUNNING、SUCCEEDED、ERROR.",
  "name": "download-123",
  "description": "a download job.",
  "configuration": {
    "logstore": "ali-test-logstore.",
    "fromTime": 1722409860,
    "toTime": 1722411060,
    "query": "* | select *",
    "powerSql": true,
    "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": "test."
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.