CheckLiveMessageUsersOnline API リファレンス - LIVE

操作説明

1 つのアカウントで、1 秒あたり最大 50 回この操作を呼び出すことができます。この制限を超えたリクエストは破棄され、サービスが中断されます。この操作を呼び出す際は、この制限に注意することを推奨します。

今すぐお試しください

この 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:CheckLiveMessageUsersOnline

none

*Domain

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	アプリケーション ID。	demo
UserIds	array	必須	照会するユーザーのリスト。
	string	任意	ユーザー ID。複数のユーザー ID はコンマ (,) で区切ります。各呼び出しで照会できるユーザー数は 1～10 です。	uid
DataCenter	string	任意	データセンター。この値は、CreateLiveMessageApp 操作を呼び出して対話型メッセージングアプリケーションを作成したときに指定したデータセンターと同じである必要があります。有効な値：cn-shanghai および ap-southeast-1 (シンガポール)。	cn-shanghai

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	178F572F-AECF-100B-937A-B8047B4D****
UserList	array<object>	照会されたユーザーのリスト。
	object
Online	boolean	ユーザーがオンラインであるかどうかを示します。	false
UserId	string	ユーザー ID。	uid1

例

成功レスポンス

JSONJSON

{
  "RequestId": "178F572F-AECF-100B-937A-B8047B4D****",
  "UserList": [
    {
      "Online": false,
      "UserId": "uid1"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InputInvalid	%s.
500	ServerError	%s.
403	NoAuth	%s.
404	ResourceNotExist	%s.

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

変更履歴

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