DescribeLiveDomainOnlineUserNum - ApsaraVideo Live

Deskripsi operasi

API ini hanya mendukung penghitungan penonton untuk aliran FLV, RTS, dan RTMP. Aliran HLS tidak didukung. Pengumpulan data mengalami keterlambatan; untuk akurasi, lakukan kueri terhadap data yang berusia minimal 5 menit.

Catatan

API ini menggantikan endpoint DescribeLiveStreamOnlineUserNum yang telah ditinggalkan.

Batas QPS

Anda dapat memanggil operasi ini hingga 200 kali per menit per akun. Permintaan yang melebihi batas ini akan dibuang 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:DescribeLiveDomainOnlineUserNum

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah.	cn-shanghai
DomainName	string	Yes	Domain streaming.	example.com
QueryTime	string	No	Titik waktu untuk dikueri. Tentukan waktu dalam standar ISO 8601 dengan format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC.	2018-12-27T13:09:21Z

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	3A3A8C3D-F8B2-4FBF-9319-771A11B855FA
UserCount	integer	Jumlah total pengguna daring pada titik waktu tertentu di domain yang ditentukan.	1
StreamCount	integer	Jumlah aliran.	1
OnlineUserInfo	object
LiveStreamOnlineUserNumInfo	array<object>	Informasi mengenai aliran.
	array<object>
StreamName	string	Nama aliran.	rtmp://example.com/test/liveStream****_3_1
Infos	object
Info	array<object>	Statistik aliran.
	object
UserNumber	integer	Jumlah penonton yang menyaksikan aliran yang telah dikodekan ulang atau aliran asli.	1
TranscodeTemplate	string	Template transkoding. Nilai origin menunjukkan bahwa aliran tersebut merupakan aliran asli yang tidak dikodekan ulang.	origin

Contoh

Respons sukses

JSONformat

{
  "RequestId": "3A3A8C3D-F8B2-4FBF-9319-771A11B855FA",
  "UserCount": 1,
  "StreamCount": 1,
  "OnlineUserInfo": {
    "LiveStreamOnlineUserNumInfo": [
      {
        "StreamName": "rtmp://example.com/test/liveStream****_3_1",
        "Infos": {
          "Info": [
            {
              "UserNumber": 1,
              "TranscodeTemplate": "origin"
            }
          ]
        }
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InternalError	The request processing has failed due to backend service exception.
400	InvalidQueryTime.Exceed	QueryTime exceed three month.
400	InvalidQueryTime.Malformed	Specified QueryTime is malformed.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.