ListLiveMessageGroupUsers API 概要 - LIVE - Alibaba Cloud - ApsaraVideo Live

操作説明

この操作を呼び出す前に、 CreateLiveMessageGroup を呼び出してインタラクティブなメッセージグループを作成している必要があります。
super large グループ (メンバー数が 2,000 を超えるグループ) では、メンバーリストのクエリはサポートされなくなります。また、メンバーの参加または退出の通知は少なくとも 5 秒間隔で送信されます。通知には参加または退出したユーザーの完全なリストは表示されませんが、正確なグループメンバー数が表示されます。グループが super large グループにアップグレードされると、メンバーリストは直ちにクリアされます。すべてのメンバーがグループから退出する (グループが閉じられる) まで、グループを通常のグループに戻すことはできません。グループが再開されると、通常のグループに復元されます。

QPS 制限

この操作の単一ユーザー QPS 制限は、1 秒あたり 50 回の呼び出しです。この制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。この操作は適切に呼び出してください。

今すぐお試しください

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

list

*Rtc

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	クエリ対象のライブインタラクティブなアプリケーションの ID。	demo
GroupId	string	必須	クエリ対象のグループのグループ ID。	grouptest
PageSize	integer	必須	ページあたりの表示ユーザー数。有効な値: 10～50。	10
SortType	integer	必須	ソート注文。ユーザーはグループへの参加時間に基づいてソートされます。有効な値: 1: 昇順。 2: 降順。列挙値: 1 : 昇順。 2 : 降順。	1
NextPageToken	integer	任意	クエリページの開始位置。このパラメーターが空の場合、デフォルトで最初のページが返されます。	1
DataCenter	string	任意	データセンター。この値は CreateLiveMessageApp で指定されたデータセンターと同じである必要があります。有効な値: cn-shanghai (上海)、ap-southeast-1 (シンガポール)。	cn-shanghai

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ。
RequestId	string	リクエスト ID。	A1D75BEA-1329-116F-B29C-76F3F200****
GroupId	string	クエリ対象のグループのグループ ID。	grouptest
NextPageToken	integer	次のページの開始位置。値が 0 の場合、次のページがないことを示します。	0
Hasmore	boolean	次のページがあるかどうかを示します。	false
UserList	array<object>	オブジェクトの配列。
	object	配列の詳細。
UserId	string	ユーザー ID。	uid1
UserInfo	string	ユーザーの拡張情報。	info1

例

成功レスポンス

JSONJSON

{
  "RequestId": "A1D75BEA-1329-116F-B29C-76F3F200****",
  "GroupId": "grouptest",
  "NextPageToken": 0,
  "Hasmore": false,
  "UserList": [
    {
      "UserId": "uid1",
      "UserInfo": "info1"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
420	SuperLargeGroup	%s.	グループのメンバーが 2000 人を超えると、スーパーグループにアップグレードされ、ユーザーリストのクエリがサポートされなくなります。
400	InputInvalid	%s.	入力パラメーターが無効です。
500	ServerError	%s.	不明なエラーが発生しました。後でもう一度お試しいただくか、チケットを送信してください。
403	NoAuth	%s.	必須の権限がありません。
404	ResourceNotExist	%s.	リクエストされたリソースが存在しません。リクエストを確認して再試行してください。

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

変更履歴

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