Web Application Firewall:DescribeDomainDetail - 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:DescribeDomainDetail

get

DefenseResource

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

DefenseResource

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	WAF インスタンスの ID。説明 DescribeInstance を呼び出して、WAF インスタンスの ID をクエリできます。	waf_cdnsdf3****
DomainId	string	任意	ドメイン名の ID。	www.aliyundoc.com-waf
Domain	string	任意	クエリするドメイン名。	www.aliyundoc.com
RegionId	string	任意	WAF インスタンスがデプロイされているリージョン。有効な値: cn-hangzhou: 中国本土。 ap-southeast-1: 中国本土以外。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object	CNAME ドメイン名の詳細。
RequestId	string	リクエスト ID。	BAEF9CA9-66A0-533E-BD09-5D5D7AA8****
Domain	string	ドメイン名。	www.aliyundoc.com
DomainId	string	ドメイン名の ID。	www.aliyundoc.com-waf
Status	integer	ドメイン名のステータス。有効な値: 1: ドメイン名は正常な状態です。 2: ドメイン名を作成中です。 3: ドメイン名を変更済みです。 4: ドメイン名をリリース中です。 5: ドメイン名はトラフィックの転送を停止しています。	1
Cname	string	WAF がドメイン名に割り当てた CNAME ドメイン名。	xxxxxcvdaf.****.com
Listen	object	リスナー構成のリスト。
HttpPorts	array	HTTP プロトコルのリッスンポートのリスト。
	integer	HTTP プロトコルのリッスンポートのリスト。	80
HttpsPorts	array	HTTPS プロトコルのリッスンポートのリスト。
	integer	HTTPS プロトコルのリッスンポートのリスト。	443
Http2Enabled	boolean	HTTP/2 が有効かどうかを示します。有効な値: true: HTTP/2 は有効です。 false: HTTP/2 は無効です。	true
CertId	string	証明書の ID。	123
TLSVersion	string	TLS バージョン。有効な値: tlsv1 tlsv1.1 tlsv1.2	tlsv1.2
EnableTLSv3	boolean	TLS 1.3 がサポートされているかどうかを示します。有効な値: true: TLS 1.3 はサポートされています。 false: TLS 1.3 はサポートされていません。	true
CipherSuite	integer	暗号スイートのタイプ。有効な値: 1: すべての暗号スイートが追加されています。 2: 強力な暗号スイートが追加されています。 99: カスタム暗号スイートが追加されています。	2
CustomCiphers	array	カスタム暗号スイート。
	string	カスタム暗号スイート。	xxx
FocusHttps	boolean	HTTPS 強制リダイレクトが有効かどうかを示します。有効な値: true: HTTPS 強制リダイレクトは有効です。 false: HTTPS 強制リダイレクトは無効です。	true
SM2Enabled	boolean	中国暗号化標準 (SM) 証明書が有効かどうかを示します。有効な値: true: SM 証明書は有効です。 false: SM 証明書は無効です。	true
SM2CertId	string	追加する SM 証明書の ID。このパラメーターは、SM2Enable が true に設定されている場合にのみ使用されます。	123-cn-hangzhou
SM2AccessOnly	boolean	SM 準拠のクライアントのみがドメイン名にアクセスできるかどうかを示します。このパラメーターは、SM2Enable が true に設定されている場合にのみ使用されます。 true: SM 準拠のクライアントのみがドメイン名にアクセスできます。 false: SM 準拠および非 SM 準拠の両方のクライアントがドメイン名にアクセスできます。	true
XffHeaderMode	integer	WAF がクライアントの送信元 IP アドレスを取得するために使用するメソッド。有効な値: 0: WAF の前にレイヤー 7 プロキシはデプロイされていません。 1: WAF は X-Forwarded-For (XFF) ヘッダーフィールドの最初の値をクライアント IP アドレスとして読み取ります。 2: WAF は指定されたカスタムヘッダーフィールドの値をクライアント IP アドレスとして読み取ります。	2
XffHeaders	array	クライアント IP アドレスの取得に使用されるカスタムヘッダーフィールドのリスト。
	string	クライアント IP アドレスの取得に使用されるカスタムヘッダーフィールドのリスト。	Client-ip
IPv6Enabled	boolean	IPv6 が有効かどうかを示します。有効な値: true: IPv6 は有効です。 false: IPv6 は無効です。	true
ProtectionResource	string	使用する保護リソースのタイプ。有効な値: share: 共有クラスター。 gslb: インテリジェント負荷分散を備えた共有クラスター。	share
ExclusiveIp	boolean	排他的 IP アドレスが有効かどうかを示します。有効な値: true: 排他的 IP アドレスは有効です。 false: 排他的 IP アドレスは無効です。	true
HstsIncludeSubDomain	boolean	HSTS にサブドメインが含まれるかどうかを示します。有効な値: true: 有効。 false: 無効。
HstsPreload	boolean	HSTS プリロードが有効かどうかを示します。この特徴はデフォルトで無効です。有効な値: true: 有効。 false: 無効。	false
HstsMaxAge	integer	HSTS の有効時間。単位: 秒。	365000
Redirect	object	転送構成。
Backends `deprecated`	array<object>	ドメイン名のバックツーオリジンアドレス。説明このパラメーターは非推奨になります。代わりに BackendList を使用してください。
	object	オリジンサーバーの IP アドレスまたはドメイン名。
Backend	string	オリジンサーバーの IP アドレスまたはドメイン名。	1.1.XX.XX
Loadbalance	string	バックツーオリジンに使用される四捨五入アルゴリズム。有効な値: iphash: IP ハッシュアルゴリズム。 roundRobin: ラウンドロビンアルゴリズム。 leastTime: 最短時間バックツーオリジンアルゴリズム。	iphash
FocusHttpBackend	boolean	強制 HTTP バックツーオリジンが有効かどうかを示します。有効な値: true: 強制 HTTP バックツーオリジンは有効です。 false: 強制 HTTP バックツーオリジンは無効です。	true
SniEnabled	boolean	バックツーオリジン SNI が有効かどうかを示します。有効な値: true: バックツーオリジン SNI は有効です。 false (デフォルト): バックツーオリジン SNI は無効です。	true
SniHost	string	カスタム SNI 拡張フィールドの値。	www.aliyundoc.com
RequestHeaders	array<object>	ドメイン名のトラフィックタグフィールドと値。WAF によって処理されたトラフィックをマークするために使用されます。
	object	ドメイン名のトラフィックタグフィールドと値。WAF によって処理されたトラフィックをマークするために使用されます。
Key	string	カスタムヘッダーフィールドのキー。	aaa
Value	string	カスタムヘッダーフィールドの値。	bbb
ConnectTimeout	integer	接続タイムアウト期間。単位: 秒。有効な値: 5 ~ 120。	120
WriteTimeout	integer	書き込みタイムアウト期間。単位: 秒。有効な値: 5 ~ 1800。	200
ReadTimeout	integer	読み取りタイムアウト期間。単位: 秒。有効な値: 5 ~ 1800。	200
Keepalive	boolean	持続的接続が有効かどうかを示します。有効な値: true (デフォルト): 持続的接続は有効です。 false: 持続的接続は無効です。	true
Retry	boolean	バックツーオリジンが失敗したときに WAF がリトライするかどうかを示します。有効な値: true (デフォルト): WAF はリトライします。 false: WAF はリトライしません。	true
KeepaliveRequests	integer	持続的接続を再利用できるリクエスト数。有効な値: 60 ~ 1000。説明持続的接続が有効になった後、このパラメーターは再利用できる持続的接続の数を指定します。	1000
KeepaliveTimeout	integer	持続的接続のアアイドルタイムアウト期間。有効な値: 1 ~ 60。デフォルト値: 15。単位: 秒。説明アイドル状態の持続的接続がリリースされるまでの保持時間を指定します。	15
XffProto	boolean	X-Forward-For-Proto ヘッダーを使用して WAF が使用するプロトコルを渡すかどうかを示します。有効な値: true (デフォルト): WAF が使用するプロトコルが渡されます。 false: WAF が使用するプロトコルは渡されません。	true
BackupBackends `deprecated`	array<object>	ドメイン名のセカンダリバックツーオリジンアドレス。説明このパラメーターは非推奨になります。代わりに BackUpBackendList を使用してください。
	object	オリジンサーバーの IP アドレスまたはドメイン名。
Backend	string	オリジンサーバーのバックアップ IP アドレスまたはドメイン名。	[ "1.1.XX.XX", "2.2.XX.XX" ]
XClientIp	boolean	WAF が X-Client-IP ヘッダーを上書きできるかどうかを示します。有効な値: true (デフォルト): WAF はヘッダーを上書きできます。 false: WAF はヘッダーを上書きできません。	true
XTrueIp	boolean	WAF が X-True-IP ヘッダーを上書きできるかどうかを示します。有効な値: true (デフォルト): WAF はヘッダーを上書きできます。 false: WAF はヘッダーを上書きできません。	true
WebServerType	boolean	WAF が Web-Server-Type ヘッダーを上書きできるかどうかを示します。有効な値: true (デフォルト): WAF はヘッダーを上書きできます。 false: WAF はヘッダーを上書きできません。	true
WLProxyClientIp	boolean	WAF が WL-Proxy-Client-IP ヘッダーを上書きできるかどうかを示します。有効な値: true (デフォルト): WAF はヘッダーを上書きできます。 false: WAF はヘッダーを上書きできません。	true
MaxBodySize	integer	最大リクエストボディサイズの最大値。有効な値: 2 ~ 10。デフォルト値: 2。単位: GB。説明この特徴は Ultimate エディションでのみサポートされています。	2
Http2Origin	boolean	HTTP/2 バックツーオリジン設定。	true
Http2OriginMaxConcurrency	integer	HTTP/2 バックツーオリジンの同時接続数の最大値。	128
ProxyProtocol	boolean	クライアントソース IP 保持特徴が有効かどうかを示します。 true: クライアントソース IP 保持特徴は有効です。この特徴を有効にすると、バックエンドサービスはクライアントの送信元 IP アドレスをビューできます。 false: クライアントソース IP 保持特徴は無効です。	false
BackendList	array	ドメイン名のオリジンサーバー IP アドレスまたはバックツーオリジンドメイン名のリスト。
	string	ドメイン名のオリジンサーバーの IP アドレスまたはドメイン名。	1.1.XX.XX
BackUpBackendList	array	ドメイン名のセカンダリオリジンサーバー IP アドレスまたはバックツーオリジンドメイン名のリスト。
	string	ドメイン名のセカンダリオリジンサーバーの IP アドレスまたはドメイン名。	2.2.XX.XX
BackendPorts	array<object>	カスタムポート構成のリスト。デフォルトでは、これはリッスンポートと同じです。
	object	カスタムポート構成のリスト。デフォルトでは、これはリッスンポートと同じです。
ListenPort	integer	リスナーポート。	80
BackendPort	integer	back-to-origin ポート。	80
Protocol	string	リスナーポートのプロトコル。有効な値： http：HTTP https：HTTPS	http
ResourceManagerResourceGroupId	string	Alibaba Cloud リソースグループの ID。	rg-acfm***q
CertDetail	object	SSL 証明書の詳細。
Name	string	証明書名。	test-cert-name
Id	string	SSL 証明書の ID。	123-cn-hangzhou
StartTime	integer	証明書の有効時間。値は UNIX タイムスタンプ (協定世界時 (UTC)) のフォーマットです。単位: ミリ秒。	1677772800000
EndTime	integer	証明書の有効期限時間。値は協定世界時 (UTC) の UNIX タイムスタンプです。単位: ミリ秒。	1685590400000
CommonName	string	共通名 (CN)。	test.aliyundoc.com
Sans	array	証明書にバインドされているすべてのドメイン名。
	string	証明書にバインドされているすべてのドメイン名。	www.aliyundoc.com
SM2CertDetail	object	SM 証明書情報のフォーマット。
Name	string	証明書名。	test-sm2-cert-name
Id	string	SSL 証明書の ID。	123-cn-hangzhou
StartTime	integer	証明書の有効時間。値は UNIX タイムスタンプ (協定世界時 (UTC)) のフォーマットです。単位: ミリ秒。	1657551525000
EndTime	integer	証明書の有効期限時間。値は協定世界時 (UTC) の UNIX タイムスタンプです。単位: ミリ秒。	1665590400000
CommonName	string	共通名 (CN)。	test.aliyundoc.com
Sans	array	証明書にバインドされているすべてのドメイン名。
	string	証明書にバインドされているすべてのドメイン名。	www.aliyundoc.com

例

成功レスポンス

JSONJSON

{
  "RequestId": "BAEF9CA9-66A0-533E-BD09-5D5D7AA8****",
  "Domain": "www.aliyundoc.com",
  "DomainId": "www.aliyundoc.com-waf",
  "Status": 1,
  "Cname": "xxxxxcvdaf.****.com",
  "Listen": {
    "HttpPorts": [
      80
    ],
    "HttpsPorts": [
      443
    ],
    "Http2Enabled": true,
    "CertId": "123",
    "TLSVersion": "tlsv1.2",
    "EnableTLSv3": true,
    "CipherSuite": 2,
    "CustomCiphers": [
      "xxx"
    ],
    "FocusHttps": true,
    "SM2Enabled": true,
    "SM2CertId": "123-cn-hangzhou",
    "SM2AccessOnly": true,
    "XffHeaderMode": 2,
    "XffHeaders": [
      "Client-ip"
    ],
    "IPv6Enabled": true,
    "ProtectionResource": "share",
    "ExclusiveIp": true,
    "HstsIncludeSubDomain": false,
    "HstsPreload": false,
    "HstsMaxAge": 365000
  },
  "Redirect": {
    "Backends": [
      {
        "Backend": "1.1.XX.XX"
      }
    ],
    "Loadbalance": "iphash",
    "FocusHttpBackend": true,
    "SniEnabled": true,
    "SniHost": "www.aliyundoc.com",
    "RequestHeaders": [
      {
        "Key": "aaa",
        "Value": "bbb"
      }
    ],
    "ConnectTimeout": 120,
    "WriteTimeout": 200,
    "ReadTimeout": 200,
    "Keepalive": true,
    "Retry": true,
    "KeepaliveRequests": 1000,
    "KeepaliveTimeout": 15,
    "XffProto": true,
    "BackupBackends": [
      {
        "Backend": "[\n    \"1.1.XX.XX\",\n    \"2.2.XX.XX\"\n]\n"
      }
    ],
    "XClientIp": true,
    "XTrueIp": true,
    "WebServerType": true,
    "WLProxyClientIp": true,
    "MaxBodySize": 2,
    "Http2Origin": true,
    "Http2OriginMaxConcurrency": 128,
    "ProxyProtocol": false,
    "BackendList": [
      "1.1.XX.XX"
    ],
    "BackUpBackendList": [
      "2.2.XX.XX"
    ],
    "BackendPorts": [
      {
        "ListenPort": 80,
        "BackendPort": 80,
        "Protocol": "http"
      }
    ]
  },
  "ResourceManagerResourceGroupId": "rg-acfm***q",
  "CertDetail": {
    "Name": "test-cert-name",
    "Id": "123-cn-hangzhou",
    "StartTime": 1677772800000,
    "EndTime": 1685590400000,
    "CommonName": "test.aliyundoc.com",
    "Sans": [
      "www.aliyundoc.com"
    ]
  },
  "SM2CertDetail": {
    "Name": "test-sm2-cert-name",
    "Id": "123-cn-hangzhou",
    "StartTime": 1657551525000,
    "EndTime": 1665590400000,
    "CommonName": "test.aliyundoc.com\n",
    "Sans": [
      "www.aliyundoc.com\n"
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Waf.Pullin.DomainAndDomainIdBothEmpty	domain and domainId cannot be empty at the same time.	ドメイン名とドメイン名 ID の両方を空にすることはできません。
400	Waf.Pullin.DomainAndDomainIdNotMatch	domain and domainId do not match.	Domain パラメーターと DomainId パラメーターが一致しません。
400	Waf.Pullin.DomainIdIsIllegal	The input parameter, the domainId is illegal.	DomainId パラメーターが無効です。

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

変更履歴

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