All Products
Search

This Product

    ApsaraVideo Live:DescribeChannelUsers

    Document Center

    ApsaraVideo Live:DescribeChannelUsers

    Last Updated:Jun 10, 2026

    Mengkueri detail pengguna online di suatu saluran.

    Deskripsi operasi

    You can call this operation to query information about online users in a channel, such as the total number of users during live streaming.

    QPS limit

    You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation.

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

    list

    *Rtc

    acs:live::{#accountId}:rtc/{#AppId}

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    AppId

    string

    Yes

    ID aplikasi. Anda hanya dapat menentukan satu ID aplikasi di permintaan.

    aec****
    ChannelId

    string

    Yes

    ID saluran. Anda hanya dapat menentukan satu ID saluran di permintaan.

    testId

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The ID of the request.

    AD86847D-1F36-18C8-A995-5EEA340B3202
    Timestamp

    integer

    The UTC timestamp when the response is returned.

    1691027655
    IsChannelExists

    boolean

    Indicates whether the channel exists. Valid values:

    • true

    • false

    Catatan

    After all users leave the channel, the system requires a few seconds to clear the cache. If you call the operation during this period, the value of this parameter is true, and the value of InteractiveUserNumber and LiveUserNumber is 0.

    true
    InteractiveUserNumber

    integer

    The number of co-streamers.

    1
    LiveUserNumber

    integer

    The number of viewers.

    1
    InteractiveUserList

    array

    The list of streamers/co-streamers.

    string

    Interactive user list.

    aaa
    LiveUserList

    array

    The list of viewers.

    string

    Viewer list, up to 1000 people returned.

    bbb

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "AD86847D-1F36-18C8-A995-5EEA34******",
  "Timestamp": 1691027655,
  "IsChannelExists": true,
  "InteractiveUserNumber": 1,
  "LiveUserNumber": 1,
  "InteractiveUserList": [
    "aaa"
  ],
  "LiveUserList": [
    "bbb"
  ]
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 400 InvalidInput
    401 401 InvalidAuth
    500 500 SystemError, Please Check App And Channel Exists, RETRY
    404 404 AppOrChannelNotExists

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.