リアルタイムライブストリーム分析のための DescribeChannelUsers API 概要 - LIVE

操作説明

この操作を呼び出して、ライブストリーミング中の総ユーザー数など、チャンネル内のオンラインユーザーに関する情報を照会できます。

QPS 制限

この操作は、アカウントあたり毎秒 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:DescribeChannelUsers

list

*Rtc

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	アプリケーション ID。 1 つのリクエストで指定できるアプリケーション ID は 1 つだけです。	aec****
ChannelId	string	必須	チャネル ID。 1 つのリクエストで指定できるチャネル ID は 1 つだけです。	testId

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	AD86847D-1F36-18C8-A995-5EEA340B3202
Timestamp	integer	応答が返されたときの UTC タイムスタンプ。	1691027655
IsChannelExists	boolean	チャンネルが存在するかどうかを示します。有効な値： true false 説明すべてのユーザーがチャンネルを退出した後、システムがキャッシュをクリアするのに数秒かかります。この期間中に操作を呼び出すと、このパラメーターの値は true になり、InteractiveUserNumber と LiveUserNumber の値は 0 になります。	true
InteractiveUserNumber	integer	共同ストリーマーの数。	1
LiveUserNumber	integer	視聴者の数。	1
InteractiveUserList	array	ストリーマー/共同ストリーマーのリスト。
	string	インタラクティブユーザーのリスト。	aaa
LiveUserList	array	視聴者のリスト。
	string	視聴者リスト。最大 1000 人が返されます。	bbb

例

成功レスポンス

JSONJSON

{
  "RequestId": "AD86847D-1F36-18C8-A995-5EEA34******",
  "Timestamp": 1691027655,
  "IsChannelExists": true,
  "InteractiveUserNumber": 1,
  "LiveUserNumber": 1,
  "InteractiveUserList": [
    "aaa"
  ],
  "LiveUserList": [
    "bbb"
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	400	InvalidInput
401	401	InvalidAuth
500	500	SystemError, Please Check App And Channel Exists, RETRY
404	404	AppOrChannelNotExists

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

変更履歴

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