BatchGetOnlineUsers - - Alibaba Cloud Dokümantasyon Merkezi

Operation description

Kullanım notları

Bu işlem toplu sorgulamaları destekler. Tek seferde en fazla 20 kullanıcının çevrimiçi durumunu sorgulayabilirsiniz.

QPS sınırları

Bu işlemi çağıran tek bir kullanıcı için QPS sınırı saniyede 100 sorgudur. Sınır aşılırsa API çağrıları kısıtlanır ve bu durum işlerinizi etkileyebilir. API çağrılarını makul bir hızda yapın. Daha fazla bilgi için bkz. QPS sınırları.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:BatchGetOnlineUsers

get

*Etki alanı.

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

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	Etkileşimli mesajlaşma uygulamasının kimliği.	a494caec-***-695ef345db77
GroupId	string	Yes	Mesaj grubunun kimliği.	23wcaec-***695ef
UserIds	string	Yes	Kullanıcı kimliklerinin listesi. Birden fazla kullanıcı kimliğini virgül (,) ile ayırın. En fazla 20 kullanıcı kimliği belirtebilirsiniz.	de1a0,hu9

Response elements

Element	Type	Description	Example
	object	Yanıt parametreleri.
RequestId	string	İsteğin kimliği.	16A96B9A-****-CB92E68F4CD8
Result	object	Döndürülen sonuç.
OnlineUsers	array<object>	Nesneler dizisi.
	object
JoinTime	integer	Kullanıcının mesaj grubuna katıldığı UTC zaman damgası. Birim: milisaniye.	12**45
Online	boolean	Kullanıcının çevrimiçi olup olmadığını gösterir. Geçerli değerler: true: Kullanıcı çevrimiçidir. false: Kullanıcı çevrimdışıdır.	true
UserId	string	Kullanıcının kimliği.	de1**a0

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden	User not authorized to operate on the specified resource.	Bu işlem için yeterli izniniz yok. Erişim izinlerini yapılandırmak için yöneticinizle iletişime geçin.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.