DescribeRefreshTasks - CDN

Panggil operasi DescribeRefreshTasks untuk mengkueri status tugas refresh dan prefetch.

Deskripsi operasi

Anda dapat mengkueri tugas berdasarkan ID tugas atau URL.
Anda dapat menentukan parameter TaskId dan ObjectPath secara bersamaan. Jika tidak menentukan parameter tersebut, operasi ini akan mengkueri 20 entri data pertama dari tiga hari terakhir secara default.
Anda hanya dapat mengkueri data dari tiga hari terakhir.
Pemanggilan API memicu pembaruan asinkron terhadap status tugas.
Jika Anda mengaktifkan refresh cache otomatis untuk Alibaba Cloud Content Delivery Network (CDN) di Konsol Object Storage Service (OSS), Anda tidak dapat menggunakan operasi DescribeRefreshTasks untuk mengkueri status tugas yang dipicu secara otomatis tersebut.
Satu pengguna dapat melakukan hingga 5 panggilan per detik. Jika memerlukan frekuensi panggilan yang lebih tinggi, gunakan operasi DescribeRefreshTaskById, yang hanya mengkueri tugas refresh dan prefetch berdasarkan ID tugas.

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 tugas yang akan dikueri.	1234321
ObjectPath	string	No	Jalur objek yang akan dikueri. Harus sesuai persis.	http://example.com/1.txt
PageNumber	integer	No	Nomor halaman yang akan ditampilkan. Nilai valid: 1 hingga 100000.	1
ObjectType	string	No	Jenis tugas. Nilai valid: file: Refresh file. directory: Refresh direktori. regex: Refresh konten berdasarkan ekspresi reguler. preload: Pra-ambil file. block: Blokir URL. unblock: Buka blokir URL. Catatan Parameter ini wajib ditentukan jika Anda menetapkan DomainName atau Status.	file
DomainName	string	No	Nama domain yang dipercepat. Anda hanya dapat menentukan satu nama domain. Jika Anda mengosongkan parameter ini, tugas untuk semua nama domain yang dipercepat akan dikueri.	example.com
Status	string	No	Status tugas. Nilai valid: Complete: Tugas selesai. Refreshing: Tugas sedang berjalan. Failed: Tugas gagal.	Complete
PageSize	integer	No	Jumlah entri yang ditampilkan per halaman. Nilai default: 20. Nilai maksimum: 100. Nilai valid: 1 hingga 100.	20
StartTime	string	No	Awal rentang waktu untuk dikueri. Tentukan waktu dalam standar ISO 8601 dengan format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam Coordinated Universal Time (UTC).	2017-12-21T08:00:00Z
EndTime	string	No	Akhir rentang waktu untuk dikueri. Tentukan waktu dalam standar ISO 8601 dengan format 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	Jumlah entri per halaman.	1
TotalCount	integer	Jumlah total tugas.	2
Tasks	object
CDNTask	array<object>	Daftar tugas.
	object
Status	string	Status tugas. Nilai valid: Complete: Tugas selesai. Refreshing: Tugas sedang berjalan. Failed: Tugas gagal.	Complete
CreationTime	string	Waktu saat tugas dibuat. Waktu dalam UTC.	2014-11-27T08:23:22Z
ObjectType	string	Jenis tugas. file: Refresh file. directory: Refresh direktori. regex: Refresh konten berdasarkan ekspresi reguler. preload: Pra-ambil file.	file
Process	string	Kemajuan tugas, dalam persentase.	100%
Description	string	Deskripsi kesalahan yang dikembalikan jika tugas refresh atau prefetch gagal. InternalError: Terjadi kesalahan internal. OriginTimeout: Origin server timeout. OriginReturnStatusCode 5XX: Origin server mengembalikan kode kesalahan 5xx.	Internal Error
ObjectPath	string	Jalur objek dalam tugas.	http://example.com/1.txt
TaskId	string	ID tugas.	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	Description
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.	You must set both the start time and the end time.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	EndTime is earlier than 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.	The format of the start time is invalid. Specify a valid value.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.	The EndTime parameter is set in an invalid format. For more information, see the API references.
400	InvalidObjectPath.Malformed	The specified ObjectPath is invalid.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid. For more information, see the API references.
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.	The parameter entered is illegal.
429	TooManyRequests	The server is busy. Please try again later.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.