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

ライブストリーミングドメインのネットワークトラフィックモニタリングデータを照会します。

操作説明

StartTime または EndTime を指定しない場合、デフォルトで過去 24 時間のデータが返されます。
これはモニタリングデータ API です。データのコレクションおよび処理メソッドは課金に使用されるメソッドとは異なります。この API を課金照合のための使用量計算に使用しないでください。

QPS 制限

この API のシングルユーザー QPS 制限は 1 秒あたり 100 回です。この制限を超えると、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:DescribeLiveDomainTrafficData

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-shanghai
DomainName	string	任意	ストリーミングドメイン。単一のドメイン名または複数のドメイン名を指定できます。複数のドメイン名はカンマ (,) で区切ります。このパラメーターを空のままにすると、デフォルトですべてのライブストリーミングドメインの統合データが返されます。説明 DomainName を指定する場合、指定するドメイン名がライブストリーミングドメインであること、および指定するドメイン名に対する必須の操作権限があることを確認してください。	example.com
StartTime	string	任意	開始時刻。協定世界時 (UTC) の yyyy-MM-ddTHH:mm:ssZ フォーマットで指定します。説明過去 90 日間のデータのクエリが可能です。	2017-12-10T14:00:00Z
EndTime	string	任意	終了時刻。終了時刻は開始時刻より後である必要があります。協定世界時 (UTC) の yyyy-MM-ddTHH:mm:ssZ フォーマットで指定します。	2017-12-10T15:00:00Z
Interval	string	任意	データをクエリする時間の粒度。単位: 秒。有効な値: 300 (デフォルト)。 3600。 86400。説明このパラメーターを設定しない場合、またはサポートされていない値に設定した場合、デフォルト値の 300 秒が使用されます。	300
IspNameEn	string	任意	インターネットサービスプロバイダー (ISP) の英語名。 DescribeCdnRegionAndIsp 操作を呼び出して ISP 名を取得できます。このパラメーターを設定しない場合、すべての ISP のデータが返されます。	alibaba
LocationNameEn	string	任意	リージョンの英語名。 DescribeCdnRegionAndIsp 操作を呼び出してリージョン名を取得できます。このパラメーターを設定しない場合、すべてのリージョンのデータが返されます。	tianjin

レスポンスフィールド

フィールド	型	説明	例
	object
EndTime	string	終了時刻。時刻は協定世界時 (UTC) の yyyy-MM-ddTHH:mm:ssZ フォーマットです。	2017-12-10T15:00:00Z
StartTime	string	開始時刻。時刻は協定世界時 (UTC) の yyyy-MM-ddTHH:mm:ssZ フォーマットです。	2017-12-10T14:00:00Z
RequestId	string	リクエスト ID。	B955107D-E658-4E77-B913-E0AC3D31693E
DomainName	string	ストリーミングドメイン。	example.com
DataInterval	string	データをクエリする時間の粒度。	300
TrafficDataPerInterval	object
DataModule	array<object>	各時間間隔のトラフィックデータ。
	object	各時間間隔のトラフィックデータ。
TrafficValue	string	総トラフィック。単位：バイト。	454680793
HttpTrafficValue	string	HTTP トラフィック。単位：バイト。	0
TimeStamp	string	時間スライスの開始時刻。	2017-12-10T15:00:05Z
HttpsTrafficValue	string	HTTPS トラフィック。単位：バイト。	454680793

例

成功レスポンス

JSONJSON

{
  "EndTime": "2017-12-10T15:00:00Z",
  "StartTime": "2017-12-10T14:00:00Z",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DomainName": "example.com",
  "DataInterval": "300",
  "TrafficDataPerInterval": {
    "DataModule": [
      {
        "TrafficValue": "454680793",
        "HttpTrafficValue": "0",
        "TimeStamp": "2017-12-10T15:00:05Z",
        "HttpsTrafficValue": "454680793"
      }
    ]
  }
}

エラーコード

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

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

変更履歴

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