すべてのプロダクト
Search
ドキュメントセンター

Cloud Firewall:DescribeNatFirewallControlPolicy

最終更新日:Jun 11, 2026

NAT ファイアウォールのアクセス制御ポリシーを取得します。

操作説明

NAT ファイアウォールのアクセス制御ポリシーを照会し、結果をページ分割されたリストで返します。

今すぐお試しください

この 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-cloudfirewall:DescribeNatFirewallControlPolicy

list

*NatFirewallControlPolicy

acs:cloudfirewall::{#accountId}:natfirewallcontrolpolicy/{#AclUuid}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Lang

string

任意

レスポンスの言語です。有効な値:

  • zh (デフォルト) :中国語

  • en :英語

zh

NatGatewayId

string

必須

NAT ゲートウェイの ID です。

ngw-xxxxxx

CurrentPage

string

任意

ページングクエリの現在のページ番号です。

1

PageSize

string

任意

ページングクエリで各ページに返すエントリの最大数です。デフォルト値は 10 です。

10

Source

string

任意

アクセス制御ポリシーのソースアドレスです。あいまい検索に対応しています。このパラメーターの値は、SourceType パラメーターの値によって異なります。

  • SourceType が net に設定されている場合、このパラメーターの値は CIDR ブロックです。例:192.0.XX.XX/24。

  • SourceType が group に設定されている場合、このパラメーターの値はアドレス帳の名前です。例:db_group。このパラメーターを空のままにすると、すべてのソースアドレスをクエリします。

  • SourceType が location に設定されている場合、このパラメーターの値はソースリージョンです。例:Beijing または beijing。リージョンは中国語または英語で指定できます。

説明

このパラメーターを設定しない場合、すべてのタイプのソースアドレスをクエリします。

1.1.1.1/32

Destination

string

任意

アクセス制御ポリシーの宛先アドレスです。あいまい検索に対応しています。このパラメーターの値は、DestinationType パラメーターの値によって異なります。

  • DestinationType が net に設定されている場合、このパラメーターの値は CIDR ブロックです。例:10.0.3.0/24。

  • DestinationType が domain に設定されている場合、このパラメーターの値はドメイン名です。例:aliyun。

  • DestinationType が group に設定されている場合、このパラメーターの値はアドレス帳の名前です。例:db_group。

  • DestinationType が location に設定されている場合、このパラメーターの値はリージョン名です。詳細については、「AddControlPolicy」をご参照ください。例:["BJ11", "ZB"]。

説明

このパラメーターを設定しない場合、すべてのタイプの宛先アドレスをクエリします。

x.x.x.x/32

Description

string

任意

アクセス制御ポリシーの説明です。あいまい検索に対応しています。

説明

このパラメーターを設定しない場合、すべてのポリシーの説明をクエリします。

test-description

Proto

string

任意

アクセス制御ポリシー内のトラフィックのプロトコルの種類です。有効な値:

  • TCP

  • UDP

  • ICMP

  • ANY (すべてのプロトコル)

説明

このパラメーターを設定しない場合、すべてのプロトコルの種類をクエリします。

ANY

AclAction

string

任意

Cloud Firewall がトラフィックに対して実行するアクションです。

有効な値:

  • accept :許可

  • drop :拒否

  • log :監視

accept

AclUuid

string

任意

アクセス制御ポリシーの一意の ID です。

323f0697-2a21-4e43-b142-*****

Release

string

任意

アクセス制御ポリシーのステータスです。デフォルトでは、アクセス制御ポリシーは作成後に有効になります。有効な値:

  • true :有効

  • false :無効

true

Direction

string

必須

アクセス制御ポリシーのトラフィックの方向です。有効な値:

  • out :アウトバウンドトラフィック

out

RepeatType

string

任意

ポリシーの有効期間の繰り返し種別です。有効な値:

  • Permanent (デフォルト) :常時

  • None :1 回限り

  • Daily :毎日

  • Weekly :毎週

  • Monthly :毎月

列挙値:

  • Daily :

    Daily

  • Monthly :

    Monthly

  • Permanent :

    Always

  • Weekly :

    Weekly

  • None :

    One-time

Permanent

レスポンスフィールド

フィールド

説明

object

TotalCount

string

返されたエントリの総数。

28

RequestId

string

リクエストの ID。

F283567D-8A52-5BAE-9472-*****

Policys

array<object>

NAT ファイアウォールのアクセス制御ポリシーに関する情報。

object

NAT ファイアウォールのアクセス制御ポリシーに関する情報。

Destination

string

アクセス制御ポリシーの宛先アドレス。このパラメーターの値は、DestinationType パラメーターの値によって異なります。有効な値:

  • DestinationTypenet の場合、値は CIDR ブロックです。例:192.0.XX.XX/24。

  • DestinationTypedomain の場合、値はドメイン名です。例:aliyuncs.com。

  • DestinationTypegroup の場合、値はアドレス帳の名前です。例:db_group。

  • DestinationTypelocation の場合、値はリージョン名です。詳細については、「AddControlPolicy」をご参照ください。例:["BJ11", "ZB"]。

x.x.x.x/32

Order

integer

アクセス制御ポリシーの優先順位。

優先順位は 1 から始まります。値が小さいほど、優先度が高くなります。

1

DestPortGroup

string

アクセス制御ポリシーの宛先ポートアドレス帳の名前。

my_port_group

SourceType

string

アクセス制御ポリシーのソースアドレスタイプ。有効な値:

  • net:CIDR ブロック

  • group:ソースアドレス帳

  • location:ソースリージョン

net

DnsResultTime

integer

DNS 名前解決のタイムスタンプ。値は UNIX タイムスタンプです。単位:秒。

1579261141

DnsResult

string

DNS 名前解決の結果。

111.0.XX.XX,112.0.XX.XX

ApplicationNameList

array

アプリケーション名。複数のアプリケーションを指定できます。

string

アプリケーション名。複数のアプリケーションを指定できます。

['HTTP', 'HTTPS']

AclUuid

string

アクセス制御ポリシーの一意の ID。

01281255-d220-4db1-8f4f-c4df221a****

DestPortType

string

アクセス制御ポリシーの宛先ポートタイプ。有効な値:

  • port:ポート

  • group:ポートアドレス帳

port

Source

string

アクセス制御ポリシーのソースアドレス。有効な値:

  • SourceTypenet の場合、値は CIDR ブロックです。例:192.0.XX.XX/24。

  • SourceTypegroup の場合、値はソースアドレス帳の名前です。例:db_group。

  • SourceTypelocation の場合、値はリージョンです。詳細については、「AddControlPolicy」をご参照ください。例:["BJ11", "ZB"]。

192.0.XX.XX/24

DestinationType

string

アクセス制御ポリシーの宛先アドレスタイプ。有効な値:

  • net:宛先 CIDR ブロック

  • group:宛先アドレス帳

  • domain:宛先ドメイン名

  • location:宛先リージョン

net

HitTimes

integer

アクセス制御ポリシーのヒット数。

100

HitLastTime

integer

最終ヒット時刻。値は UNIX タイムスタンプです。単位:秒。

1579261141

DestPort

string

アクセス制御ポリシーの宛先ポート。

80

Description

string

アクセス制御ポリシーの説明。

test-description

AclAction

string

Cloud Firewall がトラフィックに対して実行するアクション。有効な値:

  • accept:許可

  • drop:拒否

  • log:監視

accept

Proto

string

アクセス制御ポリシーのプロトコルタイプ。有効な値:

  • ANY

  • TCP

  • UDP

  • ICMP

TCP

DestinationGroupCidrs

array

宛先アドレス帳に含まれる CIDR ブロックのリスト。

string

宛先アドレス帳に含まれる CIDR ブロックのリスト。

[ "112.0.XX.XX/24", "112.0.XX.XX/32" ]

DestPortGroupPorts

array

宛先ポートアドレス帳にあるポートのリスト。

string

宛先ポートアドレス帳にあるポートのリスト。

[80,443]

SourceGroupCidrs

array

ソースアドレス帳に含まれる CIDR ブロックのリスト。

string

ソースアドレス帳に含まれる CIDR ブロックのリスト。

['192.0.XX.XX/24', '192.0.XX.XX/32']

Release

string

アクセス制御ポリシーが有効かどうかを示します。ポリシーは作成後、デフォルトで有効になります。有効な値:

  • true:有効

  • false:無効

true

SourceGroupType

string

アクセス制御ポリシーのソースアドレス帳のタイプ。値は IP で固定です。IP は、1 つ以上の IP アドレスの CIDR ブロックを含む IP アドレス帳を意味します。

ip

DestinationGroupType

string

アクセス制御ポリシーの宛先アドレス帳のタイプ。有効な値:

  • IP:1 つ以上の IP アドレス CIDR ブロックを含む IP アドレス帳。

  • domain:1 つ以上のドメイン名を含むドメイン名アドレス帳。

ip

NatGatewayId

string

NAT ゲートウェイの ID。

ngw-xxxxxx

DomainResolveType

integer

アクセス制御ポリシーのドメイン名解決方法。デフォルトで有効です。有効な値:

  • 0:FQDN ベース

  • 1:DNS ベースの動的解決

  • 2:FQDN ベースと DNS ベースの動的解決

0

SpreadCnt

string

ポリシーが使用する仕様の数。各ポリシーが使用する仕様数の累計です。 単一のポリシーが使用する仕様数 = ソース CIDR ブロック数 × 宛先アドレス数 (IP アドレス CIDR ブロック、リージョン、またはドメイン名) × アプリケーション数 × ポート範囲数。

10,000

CreateTime

integer

ポリシーが作成された時刻。値は UNIX タイムスタンプです。単位:秒。

1761062400

ModifyTime

integer

ポリシーが最終変更された時刻。値は UNIX タイムスタンプです。単位:秒。

1761062400

RepeatType

string

ポリシーの有効期間の繰り返しタイプ。有効な値:

  • Permanent (デフォルト):常時

  • None:1 回限り

  • Daily:毎日

  • Weekly:毎週

  • Monthly:毎月

列挙値:

  • Daily :

    Daily

  • Monthly :

    Monthly

  • Permanent :

    Always

  • Weekly :

    Weekly

  • None :

    Specify a single time

Permanent

RepeatDays

array

ポリシーが繰り返される曜日または日。

  • RepeatType が PermanentNone、または Daily に設定されている場合、このパラメーターは空の配列です。 例:[]

  • RepeatType が Weekly に設定されている場合、このパラメーターを空にすることはできません。 例:[0, 6]

説明

RepeatType が Weekly に設定されている場合、RepeatDays 内で同じ曜日を複数指定することはできません。

  • RepeatType が Monthly に設定されている場合、このパラメーターを空にすることはできません。 例:[1, 31]

説明

RepeatType が Monthly に設定されている場合、RepeatDays 内で同じ日付を複数指定することはできません。

integer

ポリシーが繰り返される曜日または日。

説明

RepeatType が Weekly に設定されている場合、有効な値は 0 から 6 です。週は日曜日から始まります。 RepeatType が Monthly に設定されている場合、有効な値は 1 から 31 です。

1

RepeatStartTime

string

繰り返しの開始時刻。時刻は 24 時間形式の HH:mm 形式です。例:08:00。

説明

RepeatType が Permanent または None の場合、このパラメーターは空になります。RepeatType が Daily、Weekly、または Monthly の場合は、このパラメーターを設定する必要があります。 時刻は 24 時間形式の HH:mm 形式です。例:08:00 および 23:30。

08:00

RepeatEndTime

string

繰り返しの終了時刻。時刻は 24 時間形式の HH:mm 形式です。例:23:00。

説明

RepeatType が Permanent または None の場合、このパラメーターは空になります。RepeatType が Daily、Weekly、または Monthly の場合は、このパラメーターを設定する必要があります。 時刻は 24 時間形式の HH:mm 形式です。例:08:00 および 23:30。

23:30

StartTime

integer

ポリシーの有効期間の開始時刻。値は UNIX タイムスタンプ (単位: 秒) です。時刻は正時または 30 分である必要があり、終了時刻の 30 分以上前に設定する必要があります。

説明

RepeatType が Permanent の場合、このパラメーターは空になります。RepeatType が None、Daily、Weekly、または Monthly の場合は、このパラメーターを設定する必要があります。

1694761200

EndTime

integer

ポリシーの有効期間の終了時刻。値は UNIX タイムスタンプ (単位: 秒) です。時刻は正時または 30 分である必要があり、開始時刻の 30 分以上後に設定する必要があります。

説明

RepeatType が Permanent の場合、このパラメーターは空になります。RepeatType が None、Daily、Weekly、または Monthly の場合は、このパラメーターを設定する必要があります。

1694764800

成功レスポンス

JSONJSON

{
  "TotalCount": "28",
  "RequestId": "F283567D-8A52-5BAE-9472-*****",
  "Policys": [
    {
      "Destination": "x.x.x.x/32",
      "Order": 1,
      "DestPortGroup": "my_port_group",
      "SourceType": "net",
      "DnsResultTime": 1579261141,
      "DnsResult": "111.0.XX.XX,112.0.XX.XX",
      "ApplicationNameList": [
        "['HTTP', 'HTTPS']"
      ],
      "AclUuid": "01281255-d220-4db1-8f4f-c4df221a****",
      "DestPortType": "port",
      "Source": "192.0.XX.XX/24",
      "DestinationType": "net",
      "HitTimes": 100,
      "HitLastTime": 1579261141,
      "DestPort": "80",
      "Description": "test-description",
      "AclAction": "accept",
      "Proto": "TCP",
      "DestinationGroupCidrs": [
        "[\n      \"112.0.XX.XX/24\",\n      \"112.0.XX.XX/32\"\n]"
      ],
      "DestPortGroupPorts": [
        "[80,443]"
      ],
      "SourceGroupCidrs": [
        "['192.0.XX.XX/24', '192.0.XX.XX/32']"
      ],
      "Release": "true",
      "SourceGroupType": "ip",
      "DestinationGroupType": "ip",
      "NatGatewayId": "ngw-xxxxxx",
      "DomainResolveType": 0,
      "SpreadCnt": "10,000",
      "CreateTime": 1761062400,
      "ModifyTime": 1761062400,
      "RepeatType": "Permanent",
      "RepeatDays": [
        1
      ],
      "RepeatStartTime": "08:00",
      "RepeatEndTime": "23:30",
      "StartTime": 1694761200,
      "EndTime": 1694764800
    }
  ]
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 ErrorParametersUid The aliUid parameter is invalid.
400 ErrorParametersPageSizeOrNo Either pageSize or pageNo is invalid.
400 ErrorParameterIpVersion The IP version is invalid.
400 ErrorParametersDirection The direction is invalid.
400 ErrorDBSelect An error occurred while querying database.
400 ErrorUnmarshalJSON An error occurred while parsing JSON.
400 ErrorParametersAppId The AppId parameter is incorrect.
400 ErrorParametersNatGatewayId Invalid parameters NatGatewayId.
400 ErrorUUIDNew The UUID is invalid.
400 ErrorParametersSource The source is invalid.
400 ErrorDomainResolve An error occurred while resolving the domain.
400 ErrorParametersDestination The Destination parameter is invalid.
400 ErrorParametersProto The protocol is invalid.
400 ErrorParametersDestPort The dst_port is invalid.
400 ErrorParametersAction The action is invalid.
400 ErrorMarshalJSON An error occurred while encoding JSON.
400 ErrorParametersAclUuid Specified parameter AclUuid is not valid.

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

変更履歴

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