DescribeDefenseResources を使用して保護オブジェクトをクエリする - WAF - Alibaba Cloud - Web Application Firewall

保護対象をページングで照会します。

今すぐお試しください

この 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:DescribeDefenseResources

list

*DefenseResource

acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	任意	WAF インスタンスのインスタンス ID。説明 DescribeInstance 操作を呼び出して、WAF インスタンスのインスタンス ID をクエリできます。	waf_cdnsdf3****
PageNumber	integer	任意	ページングを使用する場合に返すページ番号。デフォルト値: 1（最初のページを示します）。	1
PageSize	integer	任意	ページングを使用する場合の 1 ページあたりのエントリ数。デフォルト値: 10（各ページに 10 件のエントリが返されることを示します）。	10
Query	string	任意	クエリ条件。値は JSON 文字列です。説明クエリ結果はクエリ条件によって異なります。詳細については、クエリパラメーターの説明を参照してください。	{\"product\":\"waf\"}
Tag	array<object>	任意	リソースタグのリスト。最大値は 20 個のタグです。
	object	任意	タグキーとタグ値で構成されるリソースタグ。
Value	string	任意	タグ値。	TagValue1
Key	string	任意	タグキー。	Tagkey1
ResourceManagerResourceGroupId	string	任意	Alibaba Cloud リソースグループの ID。	rg-acfm***q
RegionId	string	任意	WAF インスタンスがデプロイされているリージョン。有効な値: cn-hangzhou: 中国本土。 ap-southeast-1: 中国本土以外。	cn-hangzhou

クエリパラメーターの説明

パラメーターの説明

名前	タイプ	必須	例	説明
product	String	いいえ	waf	アセットタイプ。有効な値: - waf: CNAME またはその他の方法で WAF に接続。 - alb: Application Load Balancer (ALB) を通じて接続。 - clb: Classic Load Balancer (CLB) を通じて接続。 - ecs: ECS を通じて接続。 - mse: Microservices Engine (MSE) を通じて接続。 - fc: Function Compute (FC) を通じて接続。
resourceLike	String	いいえ	example.aliyundoc.c	保護対象の名前。このパラメーターを設定して、WAF に接続されている保護対象のあいまいクエリを実行できます。
resource	String	いいえ	example.aliyundoc.com-waf	保護対象の名前。このパラメーターを設定して、WAF に接続されている保護対象の完全一致クエリを実行できます。
resourceIn	String	いいえ	example1.aliyundoc.com,example2.aliyundoc.com	複数の保護対象の名前。このパラメーターを設定して、WAF に接続されている複数の保護対象を照会できます。複数の保護対象はコンマ (,) で区切ります。
instanceId	String	いいえ	alb-nifa24****	保護対象のインスタンス ID。このパラメーターを設定して、WAF に接続されている保護対象のインスタンス ID の完全一致クエリを実行できます。
domain	String	いいえ	example.aliyundoc.com	保護対象のドメイン名。このパラメーターを設定して、WAF に接続されている保護対象のドメイン名の完全一致クエリを実行できます。
resourceGroup	String	いいえ	group1	照会する保護グループ。
inGroup	Boolean	いいえ	true	保護対象が保護グループに追加されているかどうかを指定します。
ownerUserId	String	いいえ	135********23	保護対象が属する Alibaba Cloud アカウントの ID。このパラメーターを設定して、マルチアカウントシナリオで特定のアカウントに属する WAF 保護対象の完全一致クエリを実行できます。
orderBy	String	いいえ	resource	保護対象のソート方法。有効な値: - resource: 保護対象名でソート。 - gmtModified: 変更時間でソート。
desc	Boolean	いいえ	true	ソート順序。有効な値: - false: 昇順。 - true: 降順。

例

{
    "product ": "waf",
    "resource": "example.aliyundoc.com-waf",
    "domain": "example.aliyundoc.com",
    "resourceLike ": "example.aliyundoc.c",
    "InstaneId": "waf_cn****",
    "resourceIn": "example1.aliyundoc.com,example2.aliyundoc.com",
    "ownerUserId": "135**********41"
}
```。

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンス構造体。
TotalCount	integer	返されたエントリの総数。	73
RequestId	string	リクエスト ID。	618F2626-DB27-5187-8C6C-4E61A491****
Resources	array<object>	保護対象のリスト。
	array<object>	保護対象のオブジェクト情報。
Pattern	string	保護対象の保護モード。	domain
Description	string	説明。	test
XffStatus	integer	保護対象に対して XFF プロキシが有効かどうかを示します。	1
GmtModified	integer	保護対象が最後に変更された時間。単位: ミリ秒。	1665633032000
Resource	string	保護対象の名前。	alb-rencs***
AcwV3SecureStatus	integer	スライダー Cookie の secure 属性のステータス。 0: 無効。 1: 有効。	0
Product	string	クラウドサービスの名前。	alb
AcwCookieStatus	integer	トラッキング Cookie のステータス。 0: 無効。 1: 有効。	1
AcwSecureStatus	integer	トラッキング Cookie の secure 属性のステータス。 0: 無効。 1: 有効。	0
ResourceManagerResourceGroupId	string	Alibaba Cloud リソースグループの ID。	rg-acfm***q
GmtCreate	integer	保護対象が作成された時間。単位: ミリ秒。	1652149203187
OwnerUserId	string	マルチアカウント管理特徴シナリオにおいて、保護対象アセットが属する Alibaba Cloud アカウント。	135*********46
ResourceOrigin	string	保護対象のオリジン。	custom
ResourceGroup	string	保護対象が追加されている保護グループの名前。	test
Detail	object	保護対象の詳細な説明。マップ内の異なるキーと値のペアは、保護対象の異なる属性を表します。	{"domain":"eou.eleme.cn","uri":"/"}
CustomHeaders	array	クライアントの送信元 IP アドレスを取得するために使用されるカスタム XFF ヘッダー。XFF が 1 に設定され、このフィールドが空の場合、XFF ヘッダーの最初の IP アドレスがクライアントの送信元 IP アドレスとして使用されます。
	string	カスタムヘッダーフィールド情報。	afbfbajf
ResponseHeaders	array<object>	レスポンスヘッダーパラメーター。
	object	レスポンスヘッダーパラメーター。
Key	string	カスタムレスポンスヘッダーのキーです。	Header-Key
Value	string	カスタムレスポンスヘッダーの値です。	Header-Value
InstanceId	string	WAF インスタンスのインスタンス ID。	waf_v2_public_cn-k*****
ResourceStatus	string	保護対象のステータス。有効な値: initializing: デフォルト保護を初期化中。 active: アクティブな状態で正常に実行中。 init_failed: デフォルト保護の初期化失敗。

例

成功レスポンス

JSONJSON

{
  "TotalCount": 73,
  "RequestId": "618F2626-DB27-5187-8C6C-4E61A491****",
  "Resources": [
    {
      "Pattern": "domain",
      "Description": "test",
      "XffStatus": 1,
      "GmtModified": 1665633032000,
      "Resource": "alb-rencs***",
      "AcwV3SecureStatus": 0,
      "Product": "alb",
      "AcwCookieStatus": 1,
      "AcwSecureStatus": 0,
      "ResourceManagerResourceGroupId": "rg-acfm***q",
      "GmtCreate": 1652149203187,
      "OwnerUserId": "135*********46",
      "ResourceOrigin": "custom",
      "ResourceGroup": "test",
      "Detail": {
        "domain": "eou.eleme.cn",
        "uri": "/"
      },
      "CustomHeaders": [
        "afbfbajf"
      ],
      "ResponseHeaders": [
        {
          "Key": "Header-Key",
          "Value": "Header-Value"
        }
      ],
      "InstanceId": "waf_v2_public_cn-k*****",
      "ResourceStatus": ""
    }
  ]
}

エラーコード

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

変更履歴

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