DescribeDomains API で WAF 保護対象ドメインをすべて取得 - WAF

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

get

*DefenseResource

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

なし

yundun-waf:DescribeDomains

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	WAF インスタンスの ID。説明現在の WAF インスタンスの ID を確認するには、DescribeInstance を呼び出してください。	waf_cdnsdf3****
ResourceManagerResourceGroupId	string	任意	Alibaba Cloud リソースグループの ID。	rg-acfm***q
Domain	string	任意	WAF に追加されたドメイン名。	www.aliyundoc.com
Backend	string	任意	オリジンサーバーの IP アドレスまたはオリジンサーバーへのドメイン名。どちらか一方のみ指定できます。	1.1.XX.XX
PageNumber	integer	任意	ページ番号。デフォルト値：1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値：10。	10
DomainId	string	任意	ドメイン名の ID。	www.aliyundoc.com-waf
RegionId	string	任意	WAF インスタンスが存在するリージョン。有効値： cn-hangzhou：中国本土。 ap-southeast-1：中国本土以外。	cn-hangzhou
Tag	array<object>	任意	リソースのタグ。最大 20 個のタグがサポートされます。
	object	任意	リソースのタグ。
Key	string	任意	タグキー。	TagKey1
Value	string	任意	タグ値。	TagValue1

レスポンスフィールド

フィールド	型	説明	例
	object	追加されたドメイン名のリスト。
RequestId	string	リクエスト ID。	ABF68BB3-2C48-5FA4-9750-D5FE55700E36
TotalCount	integer	返されたドメイン名構成の総数。	146
Domains	array<object>	ドメイン名のリスト。
	array<object>	CNAME ドメイン名の接続詳細です。
Domain	string	WAF に追加されたドメイン名。	www.aliyundoc.com
Status	integer	ドメイン名のステータス。有効値： 1：ドメイン名は通常状態です。 2：ドメイン名は作成中です。 3：ドメイン名は変更中です。 4：ドメイン名はリリース中です。 5：ドメイン名の転送が無効になっています。	1
Cname	string	WAF によってドメイン名に割り当てられた CNAME。	xxxxxcvdaf.****.com
ListenPorts	object	リスナーの構成。
Http	array	HTTP プロトコルのリスニングポートのリスト。
	integer	HTTP プロトコルのリスニングポート。	80
Https	array	HTTPS プロトコルのリスニングポートのリスト。
	integer	HTTPS プロトコルのリスニングポート。	443
Backeds	object	オリジンサーバーへの設定。
Http	array<object>	HTTP プロトコルのオリジンアドレスのリスト。
	object	HTTP プロトコルのオリジンアドレス。
Backend	string	HTTP プロトコルのオリジンアドレス。	1.1.XX.XX
Https	array<object>	HTTPS プロトコルのオリジンアドレスのリスト。
	object	HTTPS プロトコルのオリジンアドレス。
Backend	string	HTTPS プロトコルのオリジンアドレス。	1.1.XX.XX
ResourceManagerResourceGroupId	string	Alibaba Cloud リソースグループの ID。	rg-acfmvtc5z52****
DomainId	string	ドメイン名の ID。	www.aliyundoc.com-waf

例

成功レスポンス

JSONJSON

{
  "RequestId": "ABF68BB3-2C48-5FA4-9750-D5FE55700E36",
  "TotalCount": 146,
  "Domains": [
    {
      "Domain": "www.aliyundoc.com",
      "Status": 1,
      "Cname": "xxxxxcvdaf.****.com",
      "ListenPorts": {
        "Http": [
          80
        ],
        "Https": [
          443
        ]
      },
      "Backeds": {
        "Http": [
          {
            "Backend": "1.1.XX.XX"
          }
        ],
        "Https": [
          {
            "Backend": "1.1.XX.XX"
          }
        ]
      },
      "ResourceManagerResourceGroupId": "rg-acfmvtc5z52****",
      "DomainId": "www.aliyundoc.com-waf"
    }
  ]
}

エラーコード

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.

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

変更履歴

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