概要 - Web Application Firewall (WAF)

攻撃リクエストや通常のサービスリクエストを含む、すべてのトラフィックの時系列統計をクエリします。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-waf:DescribeNetworkFlowTimeSeriesMetric

get

*All Resource

*

acs:ResourceGroupId

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	WAF インスタンスの ID。説明 DescribeInstance を呼び出して、ご利用の WAF インスタンスの ID をクエリします。	waf_cdnsdf3****
Filter	object	必須	クエリのフィルター条件。複数のフィルター条件は論理 AND 関係を持ちます。
DateRange	object	必須	クエリする時間範囲。
StartDate	integer	必須	クエリ時間範囲は過去 30 日を超えることはできません。クエリする時間範囲の開始。この値は UNIX タイムスタンプです。単位：秒。説明開始時刻は過去 30 日以内である必要があります。	1713888000
EndDate	integer	必須	クエリする時間範囲の終了。この値は UNIX タイムスタンプです。単位：秒。	1713888600
Conditions	array<object>	任意	フィルター条件のリスト。各項目はフィルター条件を記述します。
	object	任意	単一のフィルター条件の構成。フィルター条件は、フィールド名、演算子、およびフィルター値で構成されます。サポートされているフィールド名と演算子の詳細については、リクエストパラメーターに関する追加情報をご参照ください。
Key	string	任意	フィルターに使用するフィールド。このパラメーターは次のフィールドをサポートしています。 matched_host：保護対象。 cluster：保護クラスター。	matched_host
OpValue	string	任意	演算子。	eq
Values	any	任意	フィルター値。	test.waf-top
Metric	string	必須	クエリするメトリック。異なるメトリックは異なるデータに対応します。このパラメーターは次のメトリックをサポートしています。 qps：WAF が 1 秒あたりに処理するリクエスト数。これはピーク値です。WAF は 10 秒ごとに秒間クエリ数 (QPS) の値を計算し、指定された時間の粒度内のピーク値を QPS として使用します。 total_requests：WAF が処理するリクエストの総数。 top5_status：WAF がクライアントに返す上位 5 つのレスポンスコードと、対応する時系列統計。 top5_upstream_status：オリジンサーバーがクライアントに返す上位 5 つのレスポンスコードと、対応する時系列統計。	total_requests
RegionId	string	任意	WAF インスタンスが存在するリージョン。有効な値： cn-hangzhou：中国本土。 ap-southeast-1：中国本土以外。	cn-hangzhou
ResourceManagerResourceGroupId	string	任意	リソースグループの ID。	rg-acfm***q

演算子の説明

演算子	意味	説明
all-not-match	いずれかの値と等しくない	フィールド値がコレクション内のいずれかの値と等しくない場合。例：real_client_ip がコレクション内のいずれかの値と等しくないリクエストをフィルターする場合： `{"Key":"real_client_ip","OpValue":"all-not-match","Values":["1.1.1.1","2.2.2.2","3.3.3.3"]}`
eq	等しい	フィールド値が文字列と等しい場合。例：URL が "/testcase" と等しいリクエストの統計をフィルターする場合： `{"Key":"request_path","OpValue":"eq","Values":"/testcase"}`
match-one	いずれかの値と等しい	フィールド値がコレクション内のいずれかの値と等しい場合。例：real_client_ip がコレクション内のいずれかの値と等しいリクエストをフィルターする場合： `{"Key":"real_client_ip","OpValue":"match-one","Values":["1.1.1.1","2.2.2.2","3.3.3.3"]}`
ne	等しくない	フィールド値が文字列と等しくない場合。例：URL が "/testcase" と等しくないリクエストの統計をフィルターする場合： `{"Key":"request_path","OpValue":"ne","Values":"/testcase"}`

フィルター条件でサポートされているキー

フィールド名	説明	サポートされている演算子
cluster	保護クラスター。	ne, eq, match-one, all-not-match
matched_host	保護対象。	ne, eq, match-one, all-not-match

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。サンプル形式については、[例] セクションをご参照ください。
RequestId	string	リクエスト ID。	D827FCFE-90A7-4330-9326-D33C8B4*****
NetworkFlowTimeSeries	array<object>	時系列データ。複数の値のデータを返すことができます。
	object	単一の時系列。時系列データは、Timestamps と Values の 2 つの配列で構成されます。Timestamps 配列には固定間隔のタイムスタンプのシーケンスが含まれます。Values 配列には各間隔の統計カウントが含まれます。2 つの配列は同じ数のデータポイントを持ち、データポイントは相互に対応します。
Metric	string	返されるデータ。このパラメーターは Metric リクエストパラメーターと同じ意味を持ちます。	total_requests
Timestamps	array	時系列。各ポイントは時間範囲の開始を表します。
	string	各データポイントの開始時刻。この値は UNIX タイムスタンプ文字列です。	[]
Values	array	データシーケンス。各ポイントは時間範囲内の統計カウントを表します。
	integer	現在の時間範囲の統計カウント。	[]
TimeSeriesMetaData	object	返されるデータのメタデータ。
DateRange	object	クエリされた時間範囲。
StartDate	integer	クエリされた時間範囲の開始。この値は UNIX タイムスタンプです。単位：秒。この値は StartDate リクエストパラメーターと同じです。	1713888000
EndDate	integer	クエリされた時間範囲の終了。この値は UNIX タイムスタンプです。単位：秒。この値は EndDate リクエストパラメーターと同じです。	1713888600
AggregateInterval	string	返される時系列の各データポイントの時間粒度。例えば、「15m」は各データポイントが 15 分間隔の統計を表すことを示します。時間の粒度の詳細については、[データポイントの時間粒度] セクションをご参照ください。	1m
Units	string	返される統計データの単位。デフォルト値は requests です。	requests

データポイントの時間粒度

返されるデータの時間の粒度は、指定された時間範囲に基づいて異なります。

時間範囲が 3 時間未満の場合、時間の粒度は 1m (1 分) です。
時間範囲が 3 時間以上 6 時間未満の場合、時間の粒度は 5m (5 分) です。
時間範囲が 6 時間以上 24 時間未満の場合、時間の粒度は 15m (15 分) です。
時間範囲が 24 時間以上 7 日未満の場合、時間の粒度は 1h (1 時間) です。
時間範囲が 7 日以上 30 日未満の場合、時間の粒度は 1d (1 日) です。

例

成功レスポンス

JSONJSON

{
  "RequestId": "D827FCFE-90A7-4330-9326-D33C8B4*****",
  "NetworkFlowTimeSeries": [
    {
      "Metric": "total_requests",
      "Timestamps": [
        "[]"
      ],
      "Values": [
        0
      ]
    }
  ],
  "TimeSeriesMetaData": {
    "DateRange": {
      "StartDate": 1713888000,
      "EndDate": 1713888600
    },
    "AggregateInterval": "1m",
    "Units": "requests"
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Waf.Report.%s	Invalid parameter:%s.
400	Waf.Report.InternalError	Server error occurred in report service.

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

変更履歴

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