BatchGetOnlineUsers によるオンラインユーザー状態の一括確認 - LIVE

操作説明

使用方法

この操作はバッチクエリをサポートしています。一度に最大 20 人のユーザーのオンラインステータスをクエリできます。

QPS 制限

100 回/秒という、この操作に対するシングルユーザーのクエリ/秒 (QPS) 制限があります。この制限を超えると、API 呼び出しがスロットルされ、ビジネスに影響を与える可能性があります。API 呼び出しは適切なレートで行う必要があります。詳細については、「QPS 制限」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

live:BatchGetOnlineUsers

get

*Domain

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	インタラクティブメッセージングアプリケーションの ID です。	a494caec-***-695ef345db77
GroupId	string	必須	メッセージグループ ID	23wcaec-***695ef
UserIds	string	必須	ユーザー ID のリスト。複数のユーザー ID はカンマ (,) で区切ります。最大 20 個のユーザー ID を指定できます。	de1a0,hu9

レスポンスフィールド

フィールド	型	説明	例
	object	返されるパラメーター。
RequestId	string	リクエスト ID。	16A96B9A-****-CB92E68F4CD8
Result	object	返された結果
OnlineUsers	array<object>	オブジェクトの配列
	object
JoinTime	integer	ユーザーがメッセージグループに参加したときの UTC タイムスタンプ。単位：ミリ秒	12**45
Online	boolean	オンラインかどうかを示します。有効な値: true: ユーザーはオンラインです。 false: ユーザーはオフラインです。	true
UserId	string	ユーザー ID。	de1**a0

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	Forbidden	User not authorized to operate on the specified resource.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。