Referensi API DescribeLiveStreamsOnlineList - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Mengkueri informasi tentang semua aliran aktif di bawah nama domain tertentu atau aplikasi tertentu di bawah nama domain.

Deskripsi operasi

Operasi ini mendukung tipe aliran berikut:

all: Mengkueri semua aliran.
raw: Mengkueri aliran mentah.
trans: Mengkueri aliran yang telah dikodekan ulang.

Batas QPS

Batas QPS untuk satu pengguna adalah 10.000 panggilan per menit. Jika batas terlampaui, panggilan API akan dibatasi, yang dapat memengaruhi bisnis Anda. Panggil operasi ini dengan frekuensi yang wajar.

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

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah.	cn-shanghai
DomainName	string	Yes	Domain streaming Streamer. Catatan Saat Anda menentukan DomainName, pastikan nama domain tersebut adalah nama domain siaran langsung dan Anda memiliki izin untuk mengelola nama domain tersebut.	example.com
AppName	string	No	Nama aplikasi tempat aliran berada. Anda dapat melihat AppName di halaman Stream Management.	liveApp****
StreamName	string	No	Nama aliran. Hanya satu NamaStream yang dapat ditentukan. Anda dapat melihat NamaStream di halaman Stream Management.	liveStream****
OnlyStream	string	No	Apakah akan mengembalikan hanya field yang ditentukan. Nilai valid: yes: Hanya field DomainName, AppName, NamaStream, dan PublishTime yang dikembalikan. no (default): Semua field dikembalikan.	no
PageSize	integer	No	Jumlah entri per halaman. Nilai valid: 1 hingga 3000. Nilai default: 2000.	1500
PageNum	integer	No	Nomor halaman. Nilai default: 1.	1
StreamType	string	No	Tipe aliran. Nilai valid: all (default): semua aliran. raw: aliran mentah. trans: aliran yang telah dikodekan ulang. Valid values: all : semua aliran. raw : aliran mentah. trans : aliran yang telah dikodekan ulang.	all
QueryType	string	No	Apakah akan menggunakan pencocokan kabur untuk nama aliran. Nilai valid: fuzzy (default): pencocokan kabur. strict: pencocokan tepat. Valid values: strict : pencocokan tepat. fuzzy : pencocokan kabur.	fuzzy

Elemen respons

Element	Type	Description	Example
	object	Informasi aliran aktif.
RequestId	string	ID permintaan.	5c6a2a0df228-4a64- af62-20e91b9676b3
TotalPage	integer	Jumlah total halaman.	2
PageNum	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri per halaman.	10
TotalNum	integer	Jumlah total entri yang memenuhi kondisi yang ditentukan.	11
OnlineInfo	object
LiveStreamOnlineInfo	array<object>	Informasi tentang aliran yang sedang diambil.
	object	Informasi tentang aliran yang sedang diambil.
AudioDataRate	integer	The audio bitrate. Unit: Kbps. Catatan This parameter can only be returned after you submit a ticket for whitelist configuration.	600
FrameRate	integer	The frame rate. Unit: frames per second (fps).	15
PublishUrl	string	The complete ingest URL.	rtmp://demo.aliyundoc.com/live/test****
StreamName	string	The stream name.	liveStream****
AudioCodecId	integer	The audio codec ID.	10
Height	integer	The height of the video resolution. Unit: pixel.	720
VideoDataRate	integer	The video bitrate. Unit: Kbps. Catatan This parameter can only be returned after you submit a ticket for whitelist configuration.	600
DomainName	string	The streaming domain.	example.com
PublishDomain	string	The ingest domain. If live center ingest was used, the streaming domain is returned.	demo.aliyundoc.com
PublishTime	string	The start time of stream ingest. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-08-09T02:37:59Z
AppName	string	The name of the application to which the stream belongs.	liveApp****
PublishType	string	The ingest type. Valid values: edge: edge ingest. center: live center ingest.	edge
VideoCodecId	integer	The video codec ID.	7
Transcoded	string	Indicates whether the stream is a transcoded stream. Valid values: yes no	no
Width	integer	The width of the video resolution. Unit: pixel.	1280
ClientIp	string	The IP address of the client for stream ingest.	106.11.XX.XX
ServerIp	string	The IP address of the ingest node.	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.