API によるライブドメイン向けリアルタイム同時視聴者メトリクスの監視 - LIVE

操作説明

この API は、FLV、RTS、および RTMP ストリームの視聴者数のみをサポートします。HLS ストリームはサポートされていません。データ収集には遅延があります。正確性を確保するため、少なくとも 5 分前のデータをクエリすることを推奨します。

説明

この API は、非推奨のエンドポイント DescribeLiveStreamOnlineUserNum を置き換えるものです。

QPS 制限

この操作は、アカウントごとに毎分最大 200 回呼び出すことができます。この制限を超えたリクエストはドロップされ、サービス中断が発生する可能性があります。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-shanghai
DomainName	string	必須	ストリーミングドメイン。	example.com
QueryTime	string	任意	クエリする時点。時間は ISO 8601 標準に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で指定する必要があります。時間は UTC である必要があります。	2018-12-27T13:09:21Z

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	3A3A8C3D-F8B2-4FBF-9319-771A11B855FA
UserCount	integer	指定されたドメインにおける、指定された時点でのオンラインユーザーの総数。	1
StreamCount	integer	ストリーム数。	1
OnlineUserInfo	object
LiveStreamOnlineUserNumInfo	array<object>	ストリームに関する情報。
	array<object>
StreamName	string	ストリーム名。	rtmp://example.com/test/liveStream****_3_1
Infos	object
Info	array<object>	ストリーム統計。
	object
UserNumber	integer	トランスコーディングされたストリームまたはオリジナルストリームを視聴している視聴者数。	1
TranscodeTemplate	string	トランスコーディングテンプレート。値が `origin` の場合、ストリームがオリジナルの、トランスコーディングされていないストリームであることを示します。	origin

例

成功レスポンス

JSONJSON

{
  "RequestId": "3A3A8C3D-F8B2-4FBF-9319-771A11B855FA",
  "UserCount": 1,
  "StreamCount": 1,
  "OnlineUserInfo": {
    "LiveStreamOnlineUserNumInfo": [
      {
        "StreamName": "rtmp://example.com/test/liveStream****_3_1",
        "Infos": {
          "Info": [
            {
              "UserNumber": 1,
              "TranscodeTemplate": "origin"
            }
          ]
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InternalError	The request processing has failed due to backend service exception.
400	InvalidQueryTime.Exceed	QueryTime exceed three month.
400	InvalidQueryTime.Malformed	Specified QueryTime is malformed.

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

変更履歴

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