Periksa Status Pengguna Online dalam Batch dengan BatchGetOnlineUsers - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Deskripsi operasi

Usage notes

This operation supports batch queries. You can query the online status of up to 20 users at a time.

QPS limits

The single-user queries per second (QPS) limit for this operation is 100 times/second. If you exceed this limit, API calls will be throttled, which may affect your business. You should make API calls at a reasonable rate. For more information, see QPS limits.

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

get

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
AppId	string	Yes	ID aplikasi pengiriman Paket interaktif.	a494caec-***-695ef345db77
GroupId	string	Yes	ID kelompok Paket.	23wcaec-***695ef
UserIds	string	Yes	Daftar ID pengguna. Pisahkan bebelaju ID pengguna dengan tanda koma (,). Anda dapat menentukan hingga 20 ID pengguna.	de1a0,hu9

Elemen respons

Element	Type	Description	Example
	object	The returned parameters.
RequestId	string	The request ID.	16A96B9A-****-CB92E68F4CD8
Result	object	The returned result
OnlineUsers	array<object>	The array of objects
	object
JoinTime	integer	The UTC timestamp when the user joined the message group. Unit: milliseconds	12**45
Online	boolean	Indicates whether the user is online. Valid values: true: The user is online. false: The user is offline.	true
UserId	string	The user ID.	de1**a0

Contoh

Respons sukses

JSONformat

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "OnlineUsers": [
      {
        "JoinTime": 0,
        "Online": true,
        "UserId": "de1**a0"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
403	Forbidden	User not authorized to operate on the specified resource.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.