DescribeDomainBpsDataByLayer でプロトコルレイヤー別の帯域幅データをクエリ - CDN

操作説明

この操作は、1 アカウントあたり 1 秒間に最大 20 回まで呼び出すことができます。
StartTime または EndTime パラメーターを指定しない場合、リクエストは過去 24 時間以内に収集されたデータを返します。両方のパラメーターを指定した場合は、指定された期間内のデータが返されます。

時間の粒度

Interval パラメーターでサポートされる時間の粒度、利用可能な既存データの最大期間、およびデータ遅延は、1 回のクエリで指定可能な最大時間範囲によって異なります。以下の表をご参照ください。

時間の粒度	1 回のクエリで指定可能な最大時間範囲	利用可能な既存データ	データ遅延
5 分	3 日	93 日	15 分
1 時間	31 日	186 日	4 時間
1 日	366 日	366 日	翌日 04:00

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cdn:DescribeDomainBpsDataByLayer

none

*Domain

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DomainName	string	任意	高速化ドメイン名です。1 回のリクエストで最大 500 個のドメイン名を指定できます。複数のドメイン名はカンマ (,) で区切ります。説明このパラメーターを指定しない場合、ご利用の Alibaba Cloud アカウントに属するすべての高速化ドメイン名に関する帯域幅データが照会されます。	example.com
StartTime	string	任意	照会対象期間の開始時刻です。 ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定してください。時刻は協定世界時 (UTC) でなければなりません。	2020-05-06T07:10:00Z
EndTime	string	任意	照会対象期間の終了時刻です。 ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定してください。時刻は協定世界時 (UTC) でなければなりません。説明終了時刻は開始時刻より後である必要があります。	2020-05-06T07:20:00Z
Interval	string	任意	データ項目の時間の粒度です。単位：秒。時間の粒度は、1 回のクエリで指定可能な最大時間範囲によって異なります。有効な値は、300（5 分）、3600（1 時間）、86400（1 日）です。詳細については、「注意事項」をご参照ください。	300
IspNameEn	string	任意	インターネットサービスプロバイダー (ISP) の名称です。DescribeCdnRegionAndIsp 操作を呼び出して、利用可能な ISP を照会できます。ISP を指定しない場合、すべての ISP のデータが照会されます。	unicom
LocationNameEn	string	任意	リージョンの名称です。DescribeCdnRegionAndIsp 操作を呼び出して、利用可能なリージョンを照会できます。リージョンを指定しない場合、すべてのリージョンのデータが照会されます。	beijing
Layer	string	任意	帯域幅データを照会するレイヤーです。有効な値は以下のとおりです。ネットワーク層：IPv4 および IPv6 アプリケーション層：http、https、quic all：ネットワーク層およびアプリケーション層の両方を含むことを指定します。デフォルト値：all	IPv4

レスポンスフィールド

フィールド	型	説明	例
	object
DataInterval	string	データ項目間の時間間隔です。単位：秒。	300
RequestId	string	リクエスト ID です。	C565B910-BC3B-467B-9046-2A48566EA967
BpsDataInterval	object
DataModule	array<object>	各時間間隔で返されるデータです。
	object
Value	string	ピーク帯域幅の値です。単位：bit/s。	75.68
TrafficValue	string	ネットワークトラフィックの合計量です。単位：バイト。	2838
TimeStamp	string	返されたデータのタイムスタンプです。	2020-05-06T07:10:00Z

例

成功レスポンス

JSONJSON

{
  "DataInterval": "300",
  "RequestId": "C565B910-BC3B-467B-9046-2A48566EA967",
  "BpsDataInterval": {
    "DataModule": [
      {
        "Value": "75.68",
        "TrafficValue": "2838",
        "TimeStamp": "2020-05-06T07:10:00Z"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingTimeParameter	The StartTime and EndTime must be both specified.
400	InvalidStartTime.Malformed	The specified value of parameter StartTime is malformed.
400	InvalidEndTime.Malformed	The specified value of parameter EndTime is malformed.
400	InvalidEndTime.Mismatch	Specified EndTime does not match the specified StartTime.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.
403	InvaildParameter	The parameter you provided is invalid.

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

変更履歴

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