DescribeLiveStreamsOnlineList - ApsaraVideo Live

Mengambil semua aliran aktif untuk Nama domain atau aplikasi tertentu.

Deskripsi operasi

Anda dapat memanggil operasi ini untuk mengkueri jenis aliran berikut:

all: mengkueri semua aliran.
raw: mengkueri aliran asli.
trans: mengkueri aliran yang telah dikodekan ulang.

Batas QPS

Anda dapat memanggil operasi ini hingga 10.000 kali per menit per akun. Permintaan yang melebihi batas ini akan dijatuhkan dan dapat menyebabkan gangguan layanan.

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

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah.	cn-shanghai
DomainName	string	Yes	Domain streaming utama. Catatan Pastikan domain tersebut merupakan domain streaming dan Anda memiliki izin yang diperlukan untuk manage-nya.	example.com
AppName	string	No	Nama aplikasi tempat aliran tersebut berada. Lihat AppName pada halaman Stream Management.	liveApp****
StreamName	string	No	Nama aliran. Anda hanya dapat menentukan satu StreamName. Lihat StreamName pada halaman Stream Management.	liveStream****
OnlyStream	string	No	Menentukan apakah hanya mengembalikan bidang tertentu. Nilai yang valid: yes: Respons hanya mengembalikan bidang DomainName, AppName, StreamName, dan PublishTime. no (default): Respons mengembalikan semua bidang.	no
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman. Nilai yang valid: 1 hingga 3000. Nilai default: 2000.	1500
PageNum	integer	No	Nomor halaman. Nilai default: 1.	1
StreamType	string	No	Jenis aliran. Nilai yang valid: all (default): mengkueri semua aliran. raw: mengkueri aliran asli. trans: mengkueri aliran yang telah dikodekan ulang.	all
QueryType	string	No	Menentukan apakah akan menggunakan pencocokan fuzzy untuk nama aliran. Nilai yang valid: fuzzy (default): pencocokan fuzzy. strict: pencocokan eksak.	fuzzy

Elemen respons

Element	Type	Description	Example
	object	Informasi tentang aliran aktif.
RequestId	string	ID permintaan.	5c6a2a0df228-4a64- af62-20e91b9676b3
TotalPage	integer	Total jumlah halaman.	2
PageNum	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri yang dikembalikan per halaman.	10
TotalNum	integer	Total jumlah entri yang memenuhi kriteria.	11
OnlineInfo	object
LiveStreamOnlineInfo	array<object>	Informasi tentang aliran aktif.
	object	Informasi tentang aliran aktif.
AudioDataRate	integer	Bitrate audio. Satuan: Kbps. Catatan Parameter ini hanya dapat dikembalikan setelah Anda mengajukan tiket untuk konfigurasi daftar putih.	600
FrameRate	integer	Laju frame. Satuan: frame per detik (fps).	15
PublishUrl	string	URL ingest lengkap.	rtmp://demo.aliyundoc.com/live/test****
StreamName	string	Nama aliran.	liveStream****
AudioCodecId	integer	ID kodek audio.	10
Height	integer	Tinggi resolusi video. Satuan: piksel.	720
VideoDataRate	integer	Bitrate video. Satuan: Kbps. Catatan Parameter ini hanya dapat dikembalikan setelah Anda mengajukan tiket untuk konfigurasi daftar putih.	600
DomainName	string	Domain streaming.	example.com
PublishDomain	string	Domain ingest. Jika pengambilan di live center digunakan, domain streaming akan dikembalikan.	demo.aliyundoc.com
PublishTime	string	Waktu mulai stream ingest. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.	2021-08-09T02:37:59Z
AppName	string	Nama aplikasi tempat aliran tersebut berada.	liveApp****
PublishType	string	Jenis ingest. Nilai yang valid: edge: edge ingest. center: live center ingest.	edge
VideoCodecId	integer	ID kodek video.	7
Transcoded	string	Menunjukkan apakah aliran tersebut merupakan aliran yang telah dikodekan ulang. Nilai yang valid: yes no	no
Width	integer	Lebar resolusi video. Satuan: piksel.	1280
ClientIp	string	Alamat IP client untuk stream ingest.	106.11.XX.XX
ServerIp	string	Alamat IP node ingest.	120.221.XX.XX

Contoh

Respons sukses

JSONformat

{
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b9676b3",
  "TotalPage": 2,
  "PageNum": 1,
  "PageSize": 10,
  "TotalNum": 11,
  "OnlineInfo": {
    "LiveStreamOnlineInfo": [
      {
        "AudioDataRate": 600,
        "FrameRate": 15,
        "PublishUrl": "rtmp://demo.aliyundoc.com/live/test****",
        "StreamName": "liveStream****",
        "AudioCodecId": 10,
        "Height": 720,
        "VideoDataRate": 600,
        "DomainName": "example.com",
        "PublishDomain": "demo.aliyundoc.com",
        "PublishTime": "2021-08-09T02:37:59Z",
        "AppName": "liveApp****",
        "PublishType": "edge",
        "VideoCodecId": 7,
        "Transcoded": "no",
        "Width": 1280,
        "ClientIp": "106.11.XX.XX",
        "ServerIp": "120.221.XX.XX"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	QpsOverLimit	Qps is over limit for this domainName.
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidEndTime.Mismatch	Specified end time does not match the specified start time.
400	Duration.Exceed	Duration between StartTime and EndTime is too long.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.