DescribeDomainDetail - - Alibaba Cloud ドキュメントセンター

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:DescribeDomainDetail

get

DefenseResource

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

DefenseResource

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	Web Application Firewall (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	Transport Layer Security (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	ドメイン名で HTTP から HTTPS へのリダイレクトが有効になっているかどうかを示します。有効な値： true：ドメイン名で HTTP から HTTPS へのリダイレクトが有効になっています。 false：ドメイン名で HTTP から HTTPS へのリダイレクトが有効になっていません。	true
SM2Enabled	boolean	SM 証明書ベースの検証が有効になっているかどうかを示します。有効な値： true：SM 証明書ベースの検証が有効になっています。 false：SM 証明書ベースの検証が有効になっていません。	true
SM2CertId	string	追加する SM 証明書の ID。このパラメーターは、SM2Enabled を true に設定した場合にのみ使用できます。	123-cn-hangzhou
SM2AccessOnly	boolean	SM 証明書ベースのクライアントのみがドメイン名にアクセスできるかどうかを示します。このパラメーターは、SM2Enabled を 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：HSTS にはサブドメインが含まれます。 false：HSTS にはサブドメインが含まれません。
HstsPreload	boolean	HSTS プリロードが有効になっているかどうかを示します。デフォルト値：false。有効な値： true：HSTS プリロードが有効になっています。 false：HSTS プリロードが無効になっています。
HstsMaxAge	integer	HSTS の生存時間 (TTL)。単位：秒。
Redirect	object	転送設定。
Backends `deprecated`	array<object>	オリジンサーバーのアドレスの配列。説明このパラメーターは非推奨になります。代わりに BackendList を使用することを推奨します。
	object	オリジンサーバーの IP アドレスまたはドメイン名。
Backend	string	オリジンサーバーの IP アドレスまたはドメイン名。	1.1.XX.XX
Loadbalance	string	WAF がオリジンサーバーにリクエストを転送するときに使用される負荷分散アルゴリズム。有効な値： iphash：IP ハッシュアルゴリズム。 roundRobin：ラウンドロビンアルゴリズム。 leastTime：最小時間アルゴリズム。	iphash
FocusHttpBackend	boolean	back-to-origin リクエストで 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～1,800。	200
ReadTimeout	integer	読み取り操作のタイムアウト期間。単位：秒。有効な値：5～1,800。	200
Keepalive	boolean	持続的接続機能が有効になっているかどうかを示します。有効な値： true (デフォルト)：持続的接続機能が有効になっています。 false：持続的接続機能が有効になっていません。	true
Retry	boolean	WAF がオリジンサーバーへのリクエストの転送に失敗した場合にリトライするかどうかを指定します。有効な値： true (デフォルト)：WAF はリトライします。 false：WAF はリトライしません。	true
KeepaliveRequests	integer	持続的接続を再利用するリクエストの数。有効な値：60～1,000。説明持続的接続機能が有効になった後の再利用される持続的接続の数。	1000
KeepaliveTimeout	integer	アイドル状態の持続的接続のタイムアウト期間。有効な値：1～60。デフォルト値：15。単位：秒。説明再利用された持続的接続が解放される前にアイドル状態でいられる期間。	15
XffProto	boolean	X-Forward-For-Proto が WAF プロトコルを渡すかどうかを示します。有効な値： true (デフォルト)：X-Forward-For-Proto は WAF プロトコルを渡します。 false：X-Forward-For-Proto は 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	Proxy Protocol 機能が有効になっているかどうかを示します。有効な値： true：Proxy Protocol 機能が有効になっています。この機能を有効にすると、バックエンドサービスはクライアントの元の IP アドレスを表示できます。 false：Proxy Protocol 機能が無効になっています。
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	リソースグループの ID。	rg-acfm***q
CertDetail	object	SSL 証明書の詳細。
Name	string	証明書の名前。	test-cert-name
Id	string	SSL 証明書の ID。	123-cn-hangzhou
StartTime	integer	SSL 証明書の有効期間の開始。UTC の UNIX タイムスタンプを指定します。単位：ミリ秒。	1677772800000
EndTime	integer	SSL 証明書の有効期間の終了。UTC の UNIX タイムスタンプを指定します。単位：ミリ秒。	1685590400000
CommonName	string	コモンネーム。	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	SSL 証明書の有効期間の開始。UTC の UNIX タイムスタンプを指定します。単位：ミリ秒。	1657551525000
EndTime	integer	SSL 証明書の有効期間の終了。UTC の UNIX タイムスタンプを指定します。単位：ミリ秒。	1665590400000
CommonName	string	コモンネーム。	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": 0
  },
  "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.
400	Waf.Pullin.DomainAndDomainIdNotMatch	domain and domainId do not match.
400	Waf.Pullin.DomainIdIsIllegal	The input parameter, the domainId is illegal.

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

変更履歴

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