DescribeChannelParticipants API によるチャンネルオンラインユーザーの取得 - LIVE

操作説明

この操作を呼び出して、チャンネル内のオンラインユーザーを照会できます。返される結果には、ユーザーの詳細は含まれません。

QPS 制限

この操作は、アカウントごとに 1 秒あたり 100 回まで呼び出すことができます。この制限を超えたリクエストはドロップされ、サービスが中断される可能性があります。この操作を呼び出す際は、この制限に注意することを推奨します。

今すぐお試しください

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

none

*Domain

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	アプリケーションの ID。指定できるアプリケーション ID は 1 つだけです。	aec****
ChannelId	string	必須	チャンネルの ID。指定できるチャンネル ID は 1 つだけです。	testId
PageNum	integer	任意	返すページ番号。デフォルト値は 1 です。	1
PageSize	integer	任意	各ページで返すエントリ数。デフォルト値は 10 です。	10
Order	string	任意	ソート順。有効な値： asc：昇順。 desc：降順。これがデフォルト値です。	asc

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエストの ID。	6159ba01-6687-4fb2-a831-f0cd8d188648
Times	integer	結果が返されるまでの経過時間。単位：秒。値は UNIX タイムスタンプです。	1557909133
TotalNum	integer	返されたエントリの数。	3
TotalPage	integer	返されたページのページ番号。	1
UserList	array	ユーザー ID のリスト。
	string	チャンネル内のユーザーの ID。複数のユーザー ID はコンマ (,) で区切られます。	27f9**,bb87,df82**

例

成功レスポンス

JSONJSON

{
  "RequestId": "6159ba01-6687-4fb2-a831-f0cd8d1******",
  "Times": 1557909133,
  "TotalNum": 3,
  "TotalPage": 1,
  "UserList": [
    "27f9****,bb87****,df82****"
  ]
}

エラーコード

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

変更履歴

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