Referensi API DescribeLiveStreamPreloadTasks - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Mengkueri data hanya dari 3 hari terakhir.

Deskripsi operasi

Operasi ini hanya mendukung pengkuerian data dari 3 hari terakhir.

Batas QPS

Batas QPS per pengguna tunggal untuk operasi ini adalah 10 panggilan per detik. Jika batas ini terlampaui, panggilan API akan dibatasi, yang dapat memengaruhi bisnis Anda. Panggil operasi ini dengan tepat.

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

live:DescribeLiveStreamPreloadTasks

get

*Domain

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah.	cn-shanghai
DomainName	string	Yes	Domain streaming.	example.com
TaskId	string	No	ID tugas. Anda dapat memperoleh ID tugas preload dengan memanggil operasi SetLiveStreamPreloadTasks.	yourTaskId
PlayUrl	string	No	URL streaming. Anda dapat menentukan beberapa URL yang dipisahkan oleh koma (,), hingga 100.	rtmp://guide.aliyundoc.com/liveApp**/liveStream**
PageSize	integer	No	Jumlah entri per halaman. Nilai maksimum: 100. Nilai valid: bilangan bulat dari 1 hingga 100.	10
PageNum	integer	No	Nomor halaman yang akan dikembalikan. Nilai default: 1.	1
Status	string	No	Status tugas. Nilai valid: complete: Selesai. pending: Menunggu preload. preloading: Preload sedang berlangsung. failed: Preload gagal. Valid values: pending : Menunggu preload. preloading : Preload sedang berlangsung. failed : Preload gagal. complete : Selesai.	complete
StartTime	string	No	Waktu mulai dalam format ISO 8601 UTC. Format: yyyy-MM-ddTHH:mm:ssZ. Waktu mulai harus berada dalam 3 hari terakhir.	2016-06-29T19:00:00Z
EndTime	string	No	Waktu akhir dalam format ISO 8601 UTC. Format: yyyy-MM-ddTHH:mm:ssZ. Interval antara EndTime dan StartTime tidak boleh melebihi 3 hari.	2016-06-30T19:00:00Z

Elemen respons

Element	Type	Description	Example
	object
PageNum	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri per halaman.	2
PreloadTasks	object
PreloadTask	array<object>	Detail tugas preload aliran langsung.
	object	Detail tugas preload aliran langsung.
Area	string	Region akselerasi tempat Anda ingin melakukan prefetch konten live. Nilai yang valid: domestic: region di daratan Tiongkok. overseas: region di luar daratan Tiongkok. global: region di dalam dan di luar daratan Tiongkok. Catatan Jika Anda tidak menentukan parameter ini, region akselerasi nama domain akan dikembalikan.	domestic
CreateTime	string	Waktu saat tugas prefetch dibuat.	2016-06-29T19:00:00Z
Description	string	Menunjukkan apakah tugas prefetch berhasil. Nilai yang valid: Successfully InternalError	Successfully
DomainName	string	Domain streaming.	example.com
PlayUrl	string	URL live stream.	rtmp://guide.aliyundoc.com/liveApp**/liveStream**
PreloadedEndTime	string	Waktu saat tugas prefetch berakhir.	2016-06-30T19:00:00Z
PreloadedStartTime	string	Waktu saat tugas prefetch dimulai.	2016-06-29T19:00:00Z
Process	string	Progres tugas prefetch.	100%
Status	string	Status tugas prefetch. Nilai yang valid: Success Failed Catatan Success dikembalikan hanya jika tugas prefetch dikonfigurasi untuk semua URL yang ditentukan.	Success
TaskId	string	ID tugas.	yourTaskId
RequestId	string	ID permintaan.	E1564CBC-DCFE-5E1B-8B78-8DED9A39F334
TotalNum	integer	Jumlah total entri yang sesuai dengan kondisi.	1
TotalPage	integer	Jumlah total halaman.	1

Contoh

Respons sukses

JSONformat

{
  "PageNum": 1,
  "PageSize": 2,
  "PreloadTasks": {
    "PreloadTask": [
      {
        "Area": "domestic",
        "CreateTime": "2016-06-29T19:00:00Z",
        "Description": "Successfully",
        "DomainName": "example.com",
        "PlayUrl": "rtmp://guide.aliyundoc.com/liveApp****/liveStream****",
        "PreloadedEndTime": "2016-06-30T19:00:00Z",
        "PreloadedStartTime": "2016-06-29T19:00:00Z",
        "Process": "100%",
        "Status": "Success",
        "TaskId": "yourTaskId"
      }
    ]
  },
  "RequestId": "E1564CBC-DCFE-5E1B-8B78-8DED9A39F334",
  "TotalNum": 1,
  "TotalPage": 1
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidParam	Parameter invalid.
400	InvalidEndTime.Mismatch	Specified end time does not match the specified start time.
400	Duration.Exceed	Duration between StartTime and EndTime is too long.
500	InternalError	The request processing has failed due to backend service exception.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.