DescribeDomainBasicConfigs - Web Application Firewall - Alibaba Cloud ドキュメントセンター

使用上の注意

DescribeDomainBasicConfigs操作を呼び出して、WAFによって保護されているドメイン名の保護設定のページクエリを実行できます。設定には、各ドメイン名の保護設定のステータス、および各保護モジュールのステータスとモードが含まれます。保護モジュールには、保護ルールエンジン、HTTPフラッド保護、およびカスタム保護ポリシーが含まれます。

制限事項

この操作は、アカウントごとに1秒あたり最大50回呼び出すことができます。 1秒あたりの呼び出し数が制限を超えると、スロットリングがトリガーされます。そのため、ビジネスに影響が発生する可能性があります。この操作を呼び出すときは、制限に注意することをお勧めします。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。利便性を考慮して、この操作は OpenAPI Explorer で呼び出すことが推奨されます。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	データ型	必須	例	説明
Action	String	必須	DescribeDomainBasicConfigs	実行する操作です。値をDescribeDomainBasicConfigsに設定します。
InstanceId	String	必須	waf-cn-tl32ast ****	WAFインスタンスのID。説明 DescribeInstanceInfo操作を呼び出して、WAFインスタンスのIDを照会できます。
DomainKey	String	任意	aliyundoc	ドメイン名のキーワード。 WAFは、キーワードを含むドメイン名の保護設定を返します。このパラメーターを指定しない場合、すべてのドメイン名の保護設定が返されます。
AccessType	String	任意	waf-cloud-dns	ドメイン名のアクセスモード。 WAFは、指定されたモードでWAFに追加されたドメイン名の保護設定を返します。有効な値： waf-cloud-dns: CNAMEレコードモード waf-cloud-native: 透過プロキシモードこのパラメーターを指定しない場合、すべてのドメイン名の保護設定が返されます。
CloudNativeProductId	Integer	任意	0	オリジンサーバーのタイプ。 WAFは、透過プロキシモードでWAFに追加され、指定されたタイプのオリジンサーバーで構成されたドメイン名の保護設定を返します。有効な値： 0: ECS (Elastic Compute Service) インスタンス。 1: Classic Load Balancer (CLB) インスタンス。 2: Application Load Balancer (ALB) インスタンス。このパラメーターを指定しない場合、すべてのドメイン名の保護設定が返されます。
PageNumber	Integer	いいえ	1	返されるページ数です。デフォルト値: 1
PageSize	Integer	任意	10	各ページで返されるエントリ数です。デフォルト値: 10
ResourceGroupId	String	任意	rg-acfm2pz25js ****	resource Managementでドメイン名が属するリソースグループのID。このパラメーターを指定しない場合、ドメイン名はデフォルトのリソースグループに属します。

すべてのAlibaba Cloud API操作に共通のリクエストパラメーターを含める必要があります。共通リクエストパラメーターの詳細については、「」をご参照ください。

サンプルリクエストの詳細については、このトピックの「例」を参照してください。

レスポンスパラメーター

パラメーター	データ型	例	説明
TotalCount	Integer	1	返されたエントリの総数です。
RequestId	String	D7861F61-5B61-46CE-A47C-6B19160D5EB0	リクエストの ID。
DomainConfigs	DomainConfigの配列		ドメイン名の保護設定。
Status	Integer	1	ドメイン名の保護設定のステータス。有効な値： 0: 无効または削除 1: 有効または作成 10: 作成 11: 作成失敗 20: 削除
ドメイン	String	www.aliyundoc.com	ドメイン名。
Owner	String	WAF	ドメイン名の保護設定のソース。値はWAFに固定されています。これは、保護設定がWAFで作成されていることを示します。
CcMode	Integer	0	HTTPフラッド保護モジュールのモード。有効な値： 0: 保護モード 1: 保護緊急モード
CcStatus	Integer	1	HTTPフラッド保護モジュールのステータス。有効な値： 0: 無効 1: enabled
AccessType	String	waf-cloud-dns	ドメイン名のアクセスモード。有効な値： waf-cloud-dns: CNAMEレコードモード waf-cloud-native: 透過プロキシモード
Version	Long	0	保護設定のバージョン。
AclStatus	Integer	1	カスタム保護ポリシーモジュールのステータス。有効な値： 0: 無効 1: enabled
WafStatus	Integer	1	保護ルールエンジンモジュールのステータス。有効な値： 0: 無効 1: enabled
WafMode	Integer	0	保護ルールエンジンモジュールのモード。有効な値： 0: ブロックモード 1: 警告モード

例

リクエストの例

http(s)://[Endpoint]/?Action=DescribeDomainBasicConfigs
&InstanceId=waf-cn-tl32ast ****
&PageNumber=1
&PageSize=10
&共通リクエストパラメータ

成功レスポンスの例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDomainBasicConfigsResponse>
    <TotalCount> 1 </ TotalCount>
    <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
    <DomainConfigs>
        <ステータス> 1</ステータス>
        <Domai n>www.aliyundoc.com</ドメイン>
        <所有者> WAF</所有者>
        <CcMode>0</CcMode>
        <CcStatus>1</CcStatus>
        <バージョン> 0</バージョン>
        <AclStatus>1</AclStatus>
        <WafStatus>1</WafStatus>
        <WafMode>0</WafMode>
    </DomainConfigs>
</DescribeDomainBasicConfigsResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1、
  "RequestId" : "D7861F61-5B61-46CE-A47C-6B19160D5EB0" 、
  "DomainConfigs" : [ {
    "ステータス" : 1、
    "ドメイン" : "www.aliyundoc.com" 、
    "所有者" : "WAF" 、
    "CcMode" : 0、
    "CcStatus" : 1、
    "バージョン" : 0,
    "AclStatus" : 1、
    "WafStatus" : 1、
    "WafMode" : 0
  } ]
}

エラーコード

エラーコードの一覧は、「API エラーセンター」をご参照ください。