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

操作説明

データの保存期間は最大 90 日間です。一度に複数のドメイン名のデータのクエリができます。複数のドメイン名はカンマ (,) で区切ります。最大 500 個のドメイン名がサポートされています。複数のドメイン名のデータは集約結果として返されます。返されるデータの時間の粒度は、StartTime と EndTime で指定された時間範囲に基づいて異なります:

時間範囲 ≤ 3 日: 時間の粒度は 5 分です。
3 日 < 時間範囲 ≤ 31 日: 時間の粒度は 1 時間です。
時間範囲 > 31 日: 時間の粒度は 1 日です。

説明

StartTime と EndTime のどちらも指定されていない場合、デフォルトで過去 24 時間のデータが返されます。

QPS 制限

この操作の単一ユーザー QPS 制限は 1 秒あたり 20 回です。制限を超えると、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:DescribeLiveDomainBpsDataByLayer

get

*Domain

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-shanghai
DomainName	string	任意	ストリーミングドメイン。複数のドメイン名をカンマ (,) で区切って指定できます。このパラメーターが空の場合、デフォルトですべてのドメイン名の集約データが返されます。	pull.aliyundoc.com
StartTime	string	任意	クエリする時間の有効値の開始時刻。yyyy-MM-ddTHH:mm:ssZ (協定世界時 (UTC)) のフォーマットで指定します。説明このパラメーターが指定されていない場合、デフォルトで過去 24 時間のデータが返されます。最小のデータ粒度は 5 分です。	2022-03-15T16:00:00Z
EndTime	string	任意	クエリする時間の有効値の終了時刻。yyyy-MM-ddTHH:mm:ssZ (協定世界時 (UTC)) のフォーマットで指定します。終了時刻は開始時刻より後である必要があります。	2022-03-16T16:59:59Z
Interval	string	任意	クエリするデータの時間の粒度。単位: 秒。有効な値: 300 3600 86400 説明時間範囲 ≤ 3 日: 有効なデータ粒度の値は 300、3600、86400 です。 3 日 < 時間範囲 ≤ 31 日: 有効なデータ粒度の値は 3600 と 86400 です。時間範囲 > 31 日: 有効な値は 86400 のみです。このパラメーターが指定されていない場合、または指定された値がサポートされていない場合、デフォルト値の 300 が使用されます。	300
IspNameEn	string	任意	インターネットサービスプロバイダー (ISP) の英語名。このパラメーターが指定されていない場合、すべての ISP のデータが返されます。説明 DescribeLiveRegionAndIsp 操作を呼び出して、リージョンと ISP の英語名をクエリできます。	tele***
LocationNameEn	string	任意	リージョンの英語名。このパラメーターが指定されていない場合、すべてのリージョンのデータが返されます。説明 DescribeLiveRegionAndIsp 操作を呼び出して、リージョンと ISP の英語名をクエリできます。	hangzhou
Layer	string	任意	クエリディメンション。有効な値: ネットワークレイヤー: IPv4、IPv6 アプリケーションレイヤー: http、https、quic all (デフォルト) 有効な値: all \| IPv4 \| IPv6 \| http \| https \| quic (大文字と小文字を区別します)。	all

レスポンスフィールド

フィールド	型	説明	例
	object
BpsDataInterval	object
DataModule	array<object>	各時間間隔の帯域幅データ (bps)。
	object	各時間間隔の帯域幅データ (bps)。
TimeStamp	string	タイムスライスの開始時刻。	2022-03-15T16:00:00Z
TrafficValue	string	合計トラフィック。単位：バイト。	331
Value	string	ピーク帯域幅。単位：bps。	0.56
DataInterval	string	データエントリ間の時間間隔。単位: 秒。	300
RequestId	string	リクエスト ID。	BEA5625F-8FCF-48F4-851B-2A48566EA967

例

成功レスポンス

JSONJSON

{
  "BpsDataInterval": {
    "DataModule": [
      {
        "TimeStamp": "2022-03-15T16:00:00Z",
        "TrafficValue": "331",
        "Value": "0.56"
      }
    ]
  },
  "DataInterval": "300",
  "RequestId": "BEA5625F-8FCF-48F4-851B-2A48566EA967"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidStartTime.Malformed	Specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	Specified parameter EndTime is not valid.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.
400	InvalidStartTime.ValueNotSupported	Specified end time does not math the specified start time,And the time range does not exceed 90 days.

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

変更履歴

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