DescribeDcdnDomainIpaTrafficData API によるレイヤー 4 トラフィックデータクエリ - Edge Security Acceleration

操作説明

説明

StartTime および EndTime パラメーターを指定しない場合、過去 24 時間のデータが返されます。両方のパラメーターを指定した場合、指定された時間範囲のデータが返されます。
データはバイト単位で測定されます。
単一ユーザーの呼び出し頻度は 100 コール/秒です。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dcdn:DescribeDcdnDomainIpaTrafficData

get

*IpaDomain

acs:dcdn:*:{#accountId}:domain/{#domainName}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DomainName	string	任意	高速化ドメイン名。複数のドメイン名をコンマ (,) で区切ります。このパラメーターを指定しない場合、すべての高速化ドメイン名のデータがクエリされます。	example.com
StartTime	string	任意	クエリする時間範囲の開始時刻。 ISO 8601 形式で時刻を指定します。時刻は協定世界時 (UTC) である必要があります。形式：yyyy-MM-ddTHH:mm:ssZ。	2017-12-10T20:00:00Z
EndTime	string	任意	クエリする時間範囲の終了時刻。 ISO 8601 形式で時刻を指定します。時刻は協定世界時 (UTC) である必要があります。形式：yyyy-MM-ddTHH:mm:ssZ。説明終了時刻は開始時刻より後である必要があります。	2017-12-10T21:00:00Z
TimeMerge	string	任意	時間の粒度を自動的に計算するかどうかを指定します。このパラメーターを 1 に設定すると、指定された時間範囲に基づいて、システムが Interval パラメーターの適切な値を計算します。TimeMerge または Interval のいずれかを指定できます。	1
Interval	string	任意	クエリするデータの時間の粒度。単位：秒。このパラメーターの値は、StartTime および EndTime パラメーターで指定された時間範囲によって異なります：時間範囲が 3 日未満の場合：300、3600、86400。このパラメーターを設定しない場合、デフォルト値は 300 です。時間範囲が 3 日以上 31 日未満の場合：3600、86400。このパラメーターを設定しない場合、デフォルト値は 3600 です。時間範囲が 31 日以上の場合：86400。このパラメーターを設定しない場合、デフォルト値は 86400 です。	300
FixTimeGap	string	任意	データをゼロで埋めるかどうかを指定します。有効値： true：データをゼロで埋めます。 false：データをゼロで埋めません。	false
IspNameEn	string	任意	キャリア名。 DescribeDcdnRegionAndIsp 操作を呼び出して、キャリア名をクエリできます。このパラメーターを指定しない場合、すべてのキャリアのデータがクエリされます。	unicom
LocationNameEn	string	任意	リージョン名。 DescribeDcdnRegionAndIsp 操作を呼び出して、リージョン名をクエリできます。このパラメーターを指定しない場合、すべてのリージョンのデータがクエリされます。	beijing

レスポンスフィールド

フィールド	型	説明	例
	object
EndTime	string	時間範囲の終了時刻。	2017-12-10T21:00:00Z
StartTime	string	時間範囲の開始時刻。	2017-12-10T20:00:00Z
RequestId	string	リクエスト ID。	B955107D-E658-4E77-B913-E0AC3D31693E
DomainName	string	高速化ドメイン名。	example.com
DataInterval	string	データレコード間の時間間隔 (秒)。	300
TrafficDataPerInterval	object
DataModule	array<object>	各時間間隔のトラフィックデータ。
	object
IpaTraffic	number	総トラフィック。	423304182
TimeStamp	string	データポイントのタイムスタンプ。	2017-12-10T20:00:00Z

例

成功レスポンス

JSONJSON

{
  "EndTime": "2017-12-10T21:00:00Z",
  "StartTime": "2017-12-10T20:00:00Z",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DomainName": "example.com",
  "DataInterval": "300",
  "TrafficDataPerInterval": {
    "DataModule": [
      {
        "IpaTraffic": 423304182,
        "TimeStamp": "2017-12-10T20:00:00Z"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingTimeParameter	The StartTime and EndTime must be both specified.
400	InvalidStartTime.Malformed	The specified StartTime parameter is invalid.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.

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

変更履歴

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