DescribeLivePullToPush - ApsaraVideo Live

Panggil operasi DescribeLivePullToPush untuk mengkueri task pull-to-push.

Deskripsi operasi

Panggil operasi ini untuk mengkueri task pull-to-push.
Anda dapat mengkueri konfigurasi dan status task berdasarkan ID-nya.

Batas QPS

Satu pengguna dapat melakukan maksimal 10 kueri per detik (QPS) pada operasi ini. Jika batas ini terlampaui, panggilan API Anda akan dikenai throttle, yang dapat memengaruhi bisnis Anda. Rencanakan panggilan API Anda secara 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:DescribeLivePullToPush

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah.	cn-shanghai
TaskId	string	Yes	ID task.	fd245384-4067-4f91-9d75-9666a6bc****
Region	string	Yes	Wilayah tempat task dijalankan. Nilai yang valid: ap-southeast-1 (Singapura) ap-southeast-5 (Indonesia) cn-beijing (Beijing) cn-shanghai (Shanghai)	cn-shanghai

Elemen respons

Element	Type	Description	Example
	object	Parameter respons
RequestId	string	ID permintaan.	a05e6b15-15af-405b-a4a2-0152245d****
RetCode	integer	Kode balasan. Catatan Nilai 0 menunjukkan bahwa permintaan berhasil. Untuk nilai lainnya, lihat kode kesalahan dalam topik ini.	0
Description	string	Deskripsi kesalahan.	OK
TaskId	string	ID task yang dibuat.	fb0d4ac7-c7e3-4978-9743-0bf2f6e8****
TaskStatus	integer	Status saat ini dari task: 0: Belum dimulai. Waktu mulai terjadwal belum tercapai. 1: Sedang berjalan. Proses pull dan ingest aliran normal. 2: Tidak normal 3: Dihentikan. Proses pull atau ingest aliran tidak normal, atau task dihentikan melalui panggilan API. -1: Keluar	0
TaskInvalidReason	string	Alasan task dihentikan: PullStreamFailed: Terjadi kesalahan saat menarik aliran sumber. Sistem sedang mencoba ulang. PushStreamFailed: Terjadi kesalahan saat mengingest aliran tujuan. Sistem sedang mencoba ulang. UnknownError: Terjadi kesalahan tak dikenal. Catatan Parameter ini hanya dikembalikan ketika task dihentikan.	PullStreamFailed
TaskExitTime	integer	Waktu task keluar. Ini adalah timestamp Unix dalam satuan detik. Catatan Parameter ini hanya dikembalikan jika task telah keluar.	1726354625
TaskExitReason	string	Alasan task keluar: TriggerByUser: Task dihentikan oleh pengguna. OverEndTime: Waktu akhir terjadwal telah tercapai. Catatan Parameter ini hanya dikembalikan jika task telah keluar.	TriggerByUser
CurrentOffset	integer	Offset pemutaran video saat ini.	0
CurrentFileIndex	integer	Offset urutan playlist saat ini.	0
TaskInfo	object	Informasi task.
TaskId	string	ID task.	fd245384-4067-4f91-9d75-9666a6bc9****
TaskName	string	Nama task.	test
StartTime	string	Waktu mulai task. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ dan ditampilkan dalam UTC.	2024-08-26T10:30:00Z
EndTime	string	Waktu akhir task. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ dan ditampilkan dalam UTC.	2024-08-27T14:30:00Z
SourceType	string	Jenis aliran sumber. Nilai yang valid: live: aliran langsung. vod: resource VOD. url: resource file video pihak ketiga.	vod
SourceProtocol	string	Protokol aliran sumber.	RTMP
SourceUrls	array	URL aliran sumber.	rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434
	string	URL aliran sumber.	rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434
DstUrl	string	URL tujuan untuk ingest aliran.	rtmp://pushtest.********.aliyunlive.com/pulltest493/pulltest-w434
CallbackURL	string	URL webhook HTTP.	https://callback*****.com
Offset	integer	Offset awal file video. Satuan: detik. Nilainya harus lebih besar dari 0. Catatan Parameter ini menentukan offset waktu dari frame pertama tempat pemutaran dimulai. Parameter ini hanya berlaku untuk resource VOD atau file video.	0
FileIndex	integer	Indeks file. Pemutaran dimulai dari file yang ditentukan dalam daftar URL sumber.	0
RetryCount	integer	Jumlah percobaan ulang.	3
RetryInterval	integer	Interval percobaan ulang. Satuan: detik.	60
RepeatNumber	integer	Jumlah kali pemutaran diulang setelah sumber selesai. Nilai yang valid: 0 (default): Pemutaran tidak diulang. -1: Aliran diputar berulang tanpa henti. Bilangan bulat positif lainnya: Jumlah kali pemutaran diulang. Catatan Parameter ini hanya berlaku untuk sumber VOD atau video pihak ketiga.	0

Contoh

Respons sukses

JSONformat

{
  "RequestId": "a05e6b15-15af-405b-a4a2-0152245d****",
  "RetCode": 0,
  "Description": "OK",
  "TaskId": "fb0d4ac7-c7e3-4978-9743-0bf2f6e8****",
  "TaskStatus": 0,
  "TaskInvalidReason": "PullStreamFailed",
  "TaskExitTime": 1726354625,
  "TaskExitReason": "TriggerByUser",
  "CurrentOffset": 0,
  "CurrentFileIndex": 0,
  "TaskInfo": {
    "TaskId": "fd245384-4067-4f91-9d75-9666a6bc9****",
    "TaskName": "test",
    "StartTime": "2024-08-26T10:30:00Z",
    "EndTime": "2024-08-27T14:30:00Z",
    "SourceType": "vod",
    "SourceProtocol": "RTMP",
    "SourceUrls": [
      "rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434"
    ],
    "DstUrl": "rtmp://pushtest.********.aliyunlive.com/pulltest493/pulltest-w434",
    "CallbackURL": "https://callback*****.com",
    "Offset": 0,
    "FileIndex": 0,
    "RetryCount": 3,
    "RetryInterval": 60,
    "RepeatNumber": 0
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidParameter	%s.	Parameter error
400	CodeInvalidAliUid	This aliuid does not have a live domain name.	This aluid does not have a live domain name.
500	InternalError	%s.	error on the live liveapi server.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.