Panggil DescribeRefreshTasks untuk menanyakan status tugas penyegaran dan prefetch - CDN - Alibaba Cloud - CDN

Panggil DescribeRefreshTasks untuk memeriksa status task refresh dan prefetch di seluruh jaringan.

Deskripsi operasi

Anda dapat mengkueri task berdasarkan ID task atau URL.
Anda dapat menentukan parameter TaskId dan ObjectPath sekaligus. Jika tidak ada parameter TaskId maupun ObjectPath yang ditentukan, operasi ini secara default mengembalikan 20 task pertama dari tiga hari terakhir.
Anda hanya dapat mengkueri data dari tiga hari terakhir.
Status task diperbarui secara asinkron. Anda harus memanggil API untuk mendapatkan status terbaru.
Jika Anda mengaktifkan refresh cache otomatis untuk CDN di Konsol OSS, antarmuka DescribeRefreshTasks tidak akan mengembalikan task tersebut.
Frekuensi pemanggilan untuk satu pengguna dibatasi hingga 5 kali per detik. Jika Anda memerlukan frekuensi yang lebih tinggi, gunakan antarmuka DescribeRefreshTaskById, yang hanya mengkueri task berdasarkan ID task.

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

cdn:DescribeRefreshTasks

none

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
TaskId	string	No	ID task yang akan dikueri.	1234321
ObjectPath	string	No	Jalur objek yang akan dikueri. Parameter ini memerlukan kecocokan eksak.	http://example.com/1.txt
PageNumber	integer	No	Nomor halaman yang akan dikembalikan. Nilai valid: 1 hingga 100000.	1
ObjectType	string	No	Jenis task. Nilai valid: file: refresh file. directory: directory refresh. regex: refresh regex. preload: preload. block: pemblokiran URL. unblock: pembatalan blokir URL. Catatan Jika Anda menentukan DomainName atau Status, parameter ini wajib diisi.	file
DomainName	string	No	Nama domain yang dipercepat. Anda hanya dapat mengkueri satu nama domain dalam satu waktu. Jika Anda tidak menentukan parameter ini, operasi akan mengembalikan task untuk semua nama domain yang dipercepat milik Anda.	example.com
Status	string	No	Status task. Nilai valid: Complete: Task berhasil diselesaikan. Refreshing: Task sedang diproses. Timeout: Task melebihi batas waktu dan tidak dieksekusi. Canceled: Task dibatalkan. Failed: Task gagal.	Complete
PageSize	integer	No	Jumlah task yang dikembalikan per halaman. Nilai default: 20. Nilai maksimum: 100. Nilai valid: 1 hingga 100.	20
StartTime	string	No	Awal rentang waktu kueri. Tentukan waktu dalam format ISO 8601: `yyyy-MM-ddTHH:mm:ssZ`. Waktu harus dalam UTC.	2017-12-21T08:00:00Z
EndTime	string	No	Akhir rentang waktu kueri. Tentukan waktu dalam format ISO 8601: `yyyy-MM-ddTHH:mm:ssZ`. Waktu harus dalam UTC. Catatan Waktu akhir harus lebih lambat daripada waktu mulai.	2017-12-22T08:00:00Z
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-acfmyuji4b6r4**

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	174F6032-AA26-470D-B90E-36F0EB205BEE
PageNumber	integer	Nomor halaman.	10
PageSize	integer	Ukuran halaman.	1
TotalCount	integer	Jumlah total.	2
Tasks	object
CDNTask	array<object>	Daftar task.
	object
Status	string	Status task. Nilai yang valid: Complete: Task selesai. Refreshing: Task sedang berjalan. Failed: Task gagal.	Complete
CreationTime	string	Waktu pembuatan task. Waktu dalam UTC.	2014-11-27T08:23:22Z
ObjectType	string	Jenis task. Nilai valid: file: URL directory: direktori regex: ekspresi reguler preload: pra-ambil	file
Process	string	Progres task dalam persentase.	100%
Description	string	Pesan error yang dikembalikan jika task refresh atau prefetch gagal. InternalError: Terjadi kesalahan internal. OriginTimeout: Origin server melebihi batas waktu. OriginReturnStatusCode 5XX: Origin server mengembalikan kode status HTTP 5xx.	Internal Error
ObjectPath	string	Jalur objek yang direfresh.	http://example.com/1.txt
TaskId	string	ID task.	704225667

Contoh

Respons sukses

JSONformat

{
  "RequestId": "174F6032-AA26-470D-B90E-36F0EB205BEE",
  "PageNumber": 10,
  "PageSize": 1,
  "TotalCount": 2,
  "Tasks": {
    "CDNTask": [
      {
        "Status": "Complete",
        "CreationTime": "2014-11-27T08:23:22Z",
        "ObjectType": "file",
        "Process": "100%",
        "Description": "Internal Error",
        "ObjectPath": "http://example.com/1.txt",
        "TaskId": "704225667"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidTaskId.Malformed	The specified TaskId is invalid.
400	MissingParameter.ObjectType	The ObjectType parameter is required if DomainName or Status is specified.
400	MissingTimeParameter	The StartTime and EndTime must be both specified.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.
400	DomainNameOverLimit	A maximum of 500 domains are supported for each request.
400	InvalidTime	The query time cannot exceed the last 3 days.
400	InvalidStartTime.Malformed	The specified StartTime is invalid.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.
400	InvalidObjectPath.Malformed	The specified ObjectPath is invalid.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.
400	InvalidEndTime.ValueNotSupported	The specified EndTime is invalid.
400	InvalidObjectType.ValueNotSupported	The specified ObjectType is not supported.
400	InvalidStatus.ValueNotSupported	The specified Status is not supported.
400	InvalidParams	The parameter you provided is invalid.
429	TooManyRequests	The server is busy. Please try again later.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.