Referensi API DescribePreloadDetailById untuk tugas prefetch CDN - CDN - Alibaba Cloud - CDN

Mengkueri progres pra-ambil sebuah Tugas, termasuk semua Sumber daya dalam Tugas tersebut. Hanya pengguna yang termasuk dalam daftar putih yang dapat menggunakan operasi ini. Anda dapat menghubungi manajer bisnis Anda untuk mengajukan daftar putih.

Deskripsi operasi

You can query data within the last 3 days.
Each account can call this operation up to 30 times per second.

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:DescribePreloadDetailById

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
TaskId	string	Yes	Mengkueri Tugas pra-ambil berdasarkan ID Tugas. Anda dapat mengkueri satu ID Tugas dalam satu pengatur waktu.	15423123921

Elemen respons

Element	Type	Description	Example
	object
TotalCount	integer	The number of queried tasks.	1
RequestId	string	The ID of the request. You can use the ID to query logs and troubleshoot issues.	E9D3257A-1B7C-414C-90C1-8D07AC47BCAC
UrlDetails	array<object>	The details of the task, including the task ID, start time, end time, domain name, success rate, status, returned error code, and completion details of all URL resources.
	array<object>
TaskId	string	The ID of the task that you want to query. You can call the PushObjectCache operation to query task IDs. Then, you can use the task IDs to query task status. You can query one task ID at a time.	14286878547
Domain	string	The domain name for prefetching resources.	example.com
CreationTime	string	The time when the task was created. The time is displayed in UTC.	2022-11-23T02:26:56Z
EndTime	string	The time when the task ended. The time is displayed in UTC.	2022-11-23T02:27:00Z
RetCode	string	The turned error code. A value of `0` indicates that the task succeeded.	0
Process	string	The progress of the prefetch task, which indicates the number of points of presence (POPs) on which the prefetch task is completed.	100%
Status	string	The status of the task. Valid values: Complete Refreshing Failed	Complete
Urls	array<object>	The completion details of all URL resources in the task.
	object
Url	string	The URL of the prefetched resource.	/abc.jpg
Success	string	The success percentage, which indicates the number of POPs on which the resource is prefetched.	47%
Description	string	The details of resource prefetch. If the resource is prefetched on all POPs, "Successfully preloaded" is returned. If the resource fails to be prefetched on some POPs, the failure details separated by vertical bars (\|) are returned.	Successfully preloaded

Contoh

Respons sukses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "E9D3257A-1B7C-414C-90C1-8D07AC47BCAC",
  "UrlDetails": [
    {
      "TaskId": "14286878547",
      "Domain": "example.com",
      "CreationTime": "2022-11-23T02:26:56Z",
      "EndTime": "2022-11-23T02:27:00Z",
      "RetCode": "0",
      "Process": "100%",
      "Status": "Complete",
      "Urls": [
        {
          "Url": "/abc.jpg\n",
          "Success": "47%",
          "Description": "Successfully preloaded"
        }
      ]
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidTaskId.Malformed	The specified TaskId is invalid.
400	DomainNameOverLimit	A maximum of 500 domains are supported for each request.
400	InvalidParameters	The parameters you provided are invalid.
400	InvalidTime	The query time cannot exceed the last 3 days.
429	TooManyRequests	Too many requests, please try again later

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.