DescribeLiveTopDomainsByFlow API リファレンス - LIVE - Alibaba Cloud - ApsaraVideo Live

DescribeLiveTopDomainsByFlow を呼び出し、トラフィック量順にユーザーのドメインをクエリします。

操作説明

StartTime または EndTime を指定しない場合、デフォルトでは当月のデータが返されます。指定した時間範囲のデータを照会することもできます。その場合、StartTime と EndTime は両方を指定する必要があります。
最大 90 日分のデータを照会できます。

QPS 制限

この操作における 1 ユーザーあたりの QPS 制限は、1 秒あたり 10 回の API 呼び出しです。上限を超えると 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:DescribeLiveTopDomainsByFlow

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-shanghai
StartTime	string	任意	照会する時間範囲の開始時刻です。時刻は、ISO 8601 フォーマットの YYYY-MM-DDThh:mm:ssZ で指定します。時刻は UTC である必要があります。最小データ粒度は 5 分です。このパラメーターを指定しない場合、デフォルトで当月のデータを返します。	2018-03-17T16:00:00Z
EndTime	string	任意	照会する時間範囲の終了時刻です。終了時刻は、開始時刻より後の時刻を指定する必要があります。時刻は、ISO 8601 フォーマットの YYYY-MM-DDThh:mm:ssZ で指定します。時刻は UTC である必要があります。	2018-03-20T16:00:00Z
Limit	integer	任意	返されるドメイン名の最大数です。デフォルト値：20。有効な値：1 ～ 100。	20

レスポンスフィールド

フィールド	型	説明	例
	object
DomainOnlineCount	integer	アカウント配下の実行中のドメイン名の合計数です。	1
EndTime	string	終了時刻です。時刻は ISO 8601 標準の YYYY-MM-DDThh:mm:ssZ フォーマットです。時刻は UTC で表記されます。	2018-03-20T16:00:00Z
StartTime	string	開始時刻です。時刻は ISO 8601 標準の YYYY-MM-DDThh:mm:ssZ フォーマットです。時刻は UTC で表記されます。	2018-03-17T16:00:00Z
RequestId	string	リクエスト ID です。	33834C3E-388E-5FFE-A8AE-63575035C064
DomainCount	integer	アカウント配下のドメイン名の合計数です。	1
TopDomains	object
TopDomain	array<object>	トラフィック量順のドメイン名リストです。
	object	トラフィック量順のドメイン名リストです。
MaxBps	integer	ピーク帯域幅です。	22139626
Rank	integer	順位です。	1
TotalAccess	integer	アクセスリクエスト数です。	107784230
TrafficPercent	string	トラフィックの割合です。	30.64191989360235
DomainName	string	ドメイン名です。	example.com
TotalTraffic	string	合計トラフィックです。	2043859876683.9001
MaxBpsTime	string	ピーク帯域幅に到達した時刻です。時刻は Unix タイムスタンプ形式 (文字列) です。	1457111400

例

成功レスポンス

JSONJSON

{
  "DomainOnlineCount": 1,
  "EndTime": "2018-03-20T16:00:00Z",
  "StartTime": "2018-03-17T16:00:00Z",
  "RequestId": "33834C3E-388E-5FFE-A8AE-63575035C064",
  "DomainCount": 1,
  "TopDomains": {
    "TopDomain": [
      {
        "MaxBps": 22139626,
        "Rank": 1,
        "TotalAccess": 107784230,
        "TrafficPercent": "30.64191989360235",
        "DomainName": "example.com",
        "TotalTraffic": "2043859876683.9001",
        "MaxBpsTime": "1457111400"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.

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

変更履歴

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