DescribeHybridCloudResources を使用したハイブリッドクラウドドメインのクエリ - 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:DescribeHybridCloudResources

get

*All Resource

*

acs:ResourceGroupId

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	WAF インスタンスの ID。説明 DescribeInstance を呼び出して、現在の WAF インスタンスの ID をクエリできます。	waf_v3prepaid_public_cn-***********
Domain	string	任意	クエリするドメイン名。	www.aliyundoc.com
Backend	string	任意	ドメイン名に対応するオリジンサーバーの IP アドレスまたはドメイン名。	1.1.XX.XX
PageNumber	integer	任意	ページングを使用する場合に返すページ番号。デフォルト値: 1 (最初のページ)。	1
PageSize	integer	任意	ページングを使用する場合の 1 ページあたりのエントリ数。デフォルト値: 10 (1 ページあたり 10 エントリ)。	10
CnameEnabled	boolean	任意	パブリッククラウドディザスタリカバリを有効にするかどうかを指定します。有効な値: true: 有効。 false: 無効。	true
RegionId	string	任意	WAF インスタンスが存在するリージョン。有効な値: cn-hangzhou: 中国本土。 ap-southeast-1: 中国本土以外。	cn-hangzhou
ResourceManagerResourceGroupId	string	任意	Alibaba Cloud リソースグループの ID。	rg-acfmvtc5z52****

レスポンスフィールド

フィールド	型	説明	例
	object
Domains	array<object>	返されるドメイン名のリスト。
	array<object>	Web サイト設定の詳細。
Status	integer	ドメイン名のステータス。有効な値: 1: 正常。 2: 作成中。 3: 変更済み。 4: リリース中。 5: 転送停止。	1
ResourceManagerResourceGroupId	string	Alibaba Cloud リソースグループの ID。	rg-acfmvtc5z52****
Uid	string	ユーザー ID。	130715431409****
Listen	object	リッスン構成。
HttpsPorts	array	HTTPS ポートのリストです。
	integer	HTTPS ポートです。	443
ProtectionResource	string	使用する保護リソースのタイプです。有効な値: share: 共有クラスターが使用されていることを示します。 gslb: 共有クラスターのインテリジェントロードバランシングが使用されていることを示します。	share
CustomCiphers	array	追加するカスタム暗号スイートです。説明このパラメーターは、CipherSuite が 99 に設定されている場合にのみ返されます。
	string	カスタム暗号スイートです。	ECDHE-ECDSA-AES128-GCM-SHA256
TLSVersion	string	TLS バージョンです。有効な値: tlsv1 tlsv1.1 tlsv1.2	tlsv1.2
Http2Enabled	boolean	HTTP/2 を有効にするかどうかを指定します。有効な値: true: HTTP/2 を有効にします。 false: HTTP/2 を有効にしません。	false
CertId	string	証明書 ID です。	72***76-cn-hangzhou
CipherSuite	integer	暗号スイートのタイプです。有効な値: 1: すべての暗号スイートが追加されていることを示します。 2: 強力な暗号スイートが追加されていることを示します。 99: カスタム暗号スイートが追加されていることを示します。	1
EnableTLSv3	boolean	TLS 1.3 がサポートされているかどうかを指定します。有効な値: true: TLS 1.3 がサポートされています。 false: TLS 1.3 はサポートされていません。	true
IPv6Enabled	boolean	IPv6 を有効にするかどうかを指定します。有効な値: true: IPv6 を有効にします。 false: IPv6 を有効にしません。	false
FocusHttps	boolean	HTTPS への強制リダイレクトを有効にするかどうかを指定します。有効な値: true: HTTPS への強制リダイレクトを有効にします。 false: HTTPS への強制リダイレクトを有効にしません。	false
XffHeaders	array	クライアント IP アドレスを取得するために使用されるカスタムヘッダーフィールドのリストです。値は `["header1","header2",...]` 形式です。説明このパラメーターは、XffHeaderMode が 2 に設定されている場合にのみ返されます。値 2 は、WAF がカスタムヘッダーフィールドの値をクライアント IP アドレスとして読み取ることを示します。
	string	クライアント IP アドレスを取得するために使用されるカスタムヘッダーフィールドのリストです。	Client-ip
XffHeaderMode	integer	WAF がクライアントの実際の IP アドレスを取得するために使用するメソッドです。有効な値: 0: WAF の前にレイヤー 7 プロキシがデプロイされていません。 1: WAF は X-Forwarded-For (XFF) ヘッダーフィールドの最初の値をクライアント IP アドレスとして読み取ります。 2: WAF はカスタムヘッダーフィールドの値をクライアント IP アドレスとして読み取ります。	0
ExclusiveIp	boolean	排他的 IP アドレスを使用するかどうかを指定します。有効な値: true: 排他的 IP アドレスが使用されます。 false: 排他的 IP アドレスは使用されません。	true
HttpPorts	array	HTTP リスナーポートのリストです。
	integer	HTTP リスナーポートです。	80
Id	integer	アクセス ID。	12345
Redirect	object	転送構成。
ConnectTimeout	integer	接続タイムアウト期間です。単位: 秒。有効な値: 5 ～ 120。	120
Keepalive	boolean	持続的接続を有効にするかどうかを指定します。有効な値: true: 持続的接続を有効にします。 false: 持続的接続を有効にしません。	true
SniEnabled	boolean	back-to-origin SNI を有効にするかどうかを指定します。有効な値: true: back-to-origin SNI を有効にします。 false: back-to-origin SNI を有効にしません。	true
CnameEnabled	boolean	パブリッククラウドディザスタリカバリを有効にするかどうかを指定します。有効な値: true: パブリッククラウドディザスタリカバリを有効にします。 false: パブリッククラウドディザスタリカバリを有効にしません。	true
KeepaliveTimeout	integer	アイドル状態の持続的接続のタイムアウト期間です。有効な値: 1 ～ 60。デフォルト値: 15。単位: 秒。説明アイドル状態の持続的接続は、タイムアウト期間が経過すると解放されます。	15
ReadTimeout	integer	読み取りタイムアウト期間です。単位: 秒。有効な値: 5 ～ 1800。	200
Backends	array	オリジンサーバーの back-to-origin IP アドレスまたはドメイン名です。
	string	オリジンサーバーの back-to-origin IP アドレスまたはドメイン名です。	1.1.XX.XX
SniHost	string	SNI 拡張フィールドのカスタム値です。このパラメーターが指定されていない場合、リクエストヘッダーの Host フィールドの値が SNI 拡張フィールドの値として使用されます。説明このパラメーターは、SniEnabled が true に設定されている場合にのみ返されます。値 true は、back-to-origin SNI が有効になっていることを示します。	www.aliyundoc.com
FocusHttpBackend	boolean	HTTP を介した強制 back-to-origin を有効にするかどうかを指定します。有効な値: true: HTTP を介した強制 back-to-origin を有効にします。 false: HTTP を介した強制 back-to-origin を有効にしません。	true
WriteTimeout	integer	書き込みタイムアウト期間です。単位: 秒。有効な値: 5 ～ 1800。	200
RoutingRules	string	ハイブリッドクラウドの転送ルールです。値は、JSON 配列で構成される文字列です。配列の各要素は、次のフィールドを含む構造体です。 rs: back-to-origin IP アドレスまたは CNAME です。このフィールドは配列型です。 location: 保護ノードの名前です。このフィールドは文字列型です。 locationId: 保護ノードの ID です。このフィールドは Long 型です。	[ { "rs": [ "1.1.XX.XX" ], "locationId": 535, "location": "test1111" } ]
Retry	boolean	back-to-origin リクエストが失敗した場合に再試行するかどうかを指定します。有効な値: true: back-to-origin リクエストが失敗した場合に再試行します。 false: back-to-origin リクエストが失敗した場合に再試行しません。	true
RequestHeaders	array<object>	WAF によって処理されるトラフィックをマークするために使用されるカスタムヘッダーフィールドと値です。
	object	WAF によって処理されるトラフィックをマークするために使用されるカスタムヘッダーフィールドと値です。
Value	string	カスタムリクエストヘッダーフィールドの値です。	bbb
Key	string	カスタムリクエストヘッダーフィールドです。	aaa
KeepaliveRequests	integer	持続的接続で再利用できるリクエストの数です。有効な値: 60 ～ 1000。説明持続的接続が確立された後に再利用されるリクエストの数です。	1000
Loadbalance	string	back-to-origin リクエストの負荷分散アルゴリズムです。有効な値: iphash: IP ハッシュアルゴリズムです。 roundRobin: ラウンドロビンアルゴリズムです。 leastTime: 最小時間アルゴリズムです。	iphash
Domain	string	ドメイン名。	www.aliyundoc.com
Cname	string	WAF によってドメイン名に割り当てられた CNAME ドメイン名。説明このパラメーターは、CnameEnabled が true (パブリッククラウドディザスタリカバリが有効であることを示す) に設定されている場合にのみ返されます。	50fqmu1ci7g0xtiyxnrhgx6qdhmn****.yundunwaf5.com
TotalCount	integer	返されるエントリの総数。	24
RequestId	string	リクエスト ID。	98D2AA9A-5959-5CCD-83E3-B6606232A2BE

例

成功レスポンス

JSONJSON

{
  "Domains": [
    {
      "Status": 1,
      "ResourceManagerResourceGroupId": "rg-acfmvtc5z52****",
      "Uid": "130715431409****",
      "Listen": {
        "HttpsPorts": [
          443
        ],
        "ProtectionResource": "share",
        "CustomCiphers": [
          "ECDHE-ECDSA-AES128-GCM-SHA256"
        ],
        "TLSVersion": "tlsv1.2",
        "Http2Enabled": false,
        "CertId": "72***76-cn-hangzhou",
        "CipherSuite": 1,
        "EnableTLSv3": true,
        "IPv6Enabled": false,
        "FocusHttps": false,
        "XffHeaders": [
          "Client-ip"
        ],
        "XffHeaderMode": 0,
        "ExclusiveIp": true,
        "HttpPorts": [
          80
        ]
      },
      "Id": 12345,
      "Redirect": {
        "ConnectTimeout": 120,
        "Keepalive": true,
        "SniEnabled": true,
        "CnameEnabled": true,
        "KeepaliveTimeout": 15,
        "ReadTimeout": 200,
        "Backends": [
          "1.1.XX.XX"
        ],
        "SniHost": "www.aliyundoc.com",
        "FocusHttpBackend": true,
        "WriteTimeout": 200,
        "RoutingRules": "[\n      {\n            \"rs\": [\n                  \"1.1.XX.XX\"\n            ],\n            \"locationId\": 535,\n            \"location\": \"test1111\"\n      }\n]",
        "Retry": true,
        "RequestHeaders": [
          {
            "Value": "bbb",
            "Key": "aaa"
          }
        ],
        "KeepaliveRequests": 1000,
        "Loadbalance": "iphash"
      },
      "Domain": "www.aliyundoc.com",
      "Cname": "50fqmu1ci7g0xtiyxnrhgx6qdhmn****.yundunwaf5.com"
    }
  ],
  "TotalCount": 24,
  "RequestId": "98D2AA9A-5959-5CCD-83E3-B6606232A2BE"
}

エラーコード

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

変更履歴

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