全部產品
Search

搜尋本產品

    Cloud Firewall：DescribeNatFirewallControlPolicy - 擷取所有NAT防火牆存取控制策略的資訊

    文件中心

    Cloud Firewall：DescribeNatFirewallControlPolicy - 擷取所有NAT防火牆存取控制策略的資訊

    更新時間：Jun 10, 2026

    擷取所有NAT防火牆存取控制策略的資訊。

    介面說明

    本介面一般用於分頁查詢 NAT 防火牆存取控制策略的資訊。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    yundun-cloudfirewall:DescribeNatFirewallControlPolicy

    list

    *NatFirewallControlPolicy

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Lang

    string

    否

    接收訊息的語言類型。取值：

    • zh（預設）：中文

    • en：英文

    zh
    NatGatewayId

    string

    是

    要查詢的 NAT Gateway的 ID。

    ngw-xxxxxx
    CurrentPage

    string

    否

    分頁查詢時，設定當前頁的頁碼。

    1
    PageSize

    string

    否

    分頁查詢時，顯示的每頁資料的最大條數。預設值為 10.

    10
    Source

    string

    否

    存取控制策略中的訪問源地址。支援使用模糊查詢的方式進行查詢。SourceType（源類型）不同，訪問源地址的取值也不同。

    • 當 SourceType 為net時，訪問源為 CIDR 格式的 IP 位址段。例如：192.0.XX.XX/24。

    • 當 SourceType 為group時，訪問源為源地址簿名稱。例如：db_group 為空白（表示查詢所有存取控制源）。

    • 當 SourceType 為location時，訪問源為來源區域。例如：北京或 beijing（支援使用中文或英文進行查詢）。

    說明

    不設定該參數表示查詢所有類型的訪問源。

    1.1.1.1/32
    Destination

    string

    否

    存取控制策略中的目的地址。支援模糊查詢。DestinationType（目的類型）不同，目的地址的取值也不同。

    • 當 DestinationType 為net時，目的地址為 CIDR 格式的 IP 位址段。例如：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：指定單次時間

    • Daily：每天

    • Weekly：每周

    • Monthly：每月

    枚舉值：

    • Daily :

      每天

    • Monthly :

      每月

    • Permanent :

      總是

    • Weekly :

      每周

    • None :

      指定單次時間

    Permanent

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    TotalCount

    string

    返回結果的總條數。

    28
    RequestId

    string

    本次請求的 ID。

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

    array<object>

    NAT 防火牆存取控制策略的資訊。

    object

    NAT 防火牆存取控制策略的資訊。

    Destination

    string

    存取控制策略中的目的地址。DestinationType（目的類型）不同，目的地址的取值也不同。取值：

    • 當 DestinationType 為 net 時，目的地址為 CIDR 格式的 IP 位址段。例如：192.0.XX.XX/24。

    • 當 DestinationType 為 domain 時，目的地址為網域名稱。例如：aliyuncs.com。

    • 當 DestinationType 為 group 時，目的地址為地址簿的名稱。例如：db_group。

    • 當 DestinationType 為 location 時，目的地址為地區名稱（具體地區位置編碼請參見 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 解析的時間戳記。使用秒級時間戳記格式表示。

    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

    存取控制策略中的訪問源地址。取值：

    • 當 SourceType 為net時，訪問源為 CIDR 格式的 IP 位址段。例如：192.0.XX.XX/24。

    • 當 SourceType 為group時，訪問源地址為源地址簿名稱。例如：db_group。

    • 當 SourceType 為location時，訪問源地址為地區（具體地區位置編碼請參見 AddControlPolicy ）。例如： ["BJ11", "ZB"]。

    192.0.XX.XX/24
    DestinationType

    string

    存取控制策略中的目的地址類型。取值：

    • net：目的網段（CIDR）

    • group：目的地址簿

    • domain：目的網域名稱

    • location：目的地區

    net
    HitTimes

    integer

    存取控制策略的叫用次數。

    100
    HitLastTime

    integer

    最新命中時間戳記。使用秒級時間戳記格式表示。

    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

    存取控制策略中的目的地址簿中的網段列表。

    string

    存取控制策略中的目的地址簿中的網段列表。

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

    array

    目的連接埠地址簿中包含的連接埠列表。

    string

    目的連接埠地址簿中包含的連接埠列表。

    [80,443]
    SourceGroupCidrs

    array

    存取控制策略中的源地址簿中的網段列表。

    string

    存取控制策略中的源地址簿中的網段列表。

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

    string

    存取控制策略的啟用狀態。策略建立後預設啟用該策略。取值：

    • true：啟用存取控制策略

    • false：不啟用存取控制策略

    true
    SourceGroupType

    string

    存取控制策略中的源地址簿類型。唯一取值： ip。表示 IP 位址簿，包含一個或多個 IP 位址段。

    ip
    DestinationGroupType

    string

    存取控制策略中的目的地址簿類型。取值：

    • ip：IP 位址簿，包含一個或多個 IP 位址段。

    • domain：網域名稱地址簿，包含一個或多個網域名稱地址。

    ip
    NatGatewayId

    string

    要查詢的 NAT Gateway的 ID。

    ngw-xxxxxx
    DomainResolveType

    integer

    存取控制策略的網域名稱解析方式。策略建立後預設啟用該策略。取值：

    • 0：基於 FQDN

    • 1：基於 DNS 動態解析

    • 2：基於 FQDN 與 DNS 動態解析

    0
    SpreadCnt

    string

    佔用存取控制策略的規格數，即每條策略佔用規格數的累加值。 單條策略佔用存取控制策略的規格數=訪問源位址區段個數 * 目的地址個數（IP 位址段個數或地區個數或網域名稱個數）* 應用數 * 連接埠段個數。

    10,000
    CreateTime

    integer

    策略建立時間。使用秒級 Unix 時間戳記表示。

    1761062400
    ModifyTime

    integer

    策略最後修改時間。使用秒級 Unix 時間戳記表示。

    1761062400
    RepeatType

    string

    存取控制策略的策略有效期間的重複類型。取值：

    • Permanent（預設）：總是

    • None：指定單次時間

    • Daily：每天

    • Weekly：每周

    • Monthly：每月

    枚舉值：

    • Daily :

      每天

    • Monthly :

      每月

    • Permanent :

      總是

    • Weekly :

      每周

    • None :

      指定單次時間

    Permanent
    RepeatDays

    array

    存取控制策略的策略有效期間的重複日期集合。

    • 當 RepeatType 為Permanent、None、Daily時，RepeatDays 為空白集合。 例如：[]

    • 當 RepeatType 為 Weekly 時，RepeatDays 不可為空。 例如：[0, 6]

    說明

    RepeatType 設定為 Weekly 時，RepeatDays 不允許重複。

    • 當 RepeatType 為Monthly時，RepeatDays 不可為空。 例如：[1, 31]

    說明

    RepeatType 設定為 Monthly 時，RepeatDays 不允許重複。

    integer

    存取控制策略的策略有效期間的重複日期。

    說明

    RepeatType 設定為 Weekly 時，取值範圍：0~6，每周開始於周日。 RepeatType 設定為 Monthly 時，取值範圍：1~31。

    1
    RepeatStartTime

    string

    策略生效的重複開始時間。使用 HH:mm 格式的 24 小時制時間，如 08:00。

    說明

    當 RepeatType 為 Permanent、None 時，RepeatStartTime 為空白。當 RepeatType 為 Daily、Weekly、Monthly 時，RepeatStartTime 必須有值，您需要設定重複開始時間。 時間格式為 HH:mm（24 小時制），例如 08:00、23:30。

    08:00
    RepeatEndTime

    string

    策略生效的重複結束時間。使用 HH:mm 格式的 24 小時制時間，如 23:00。

    說明

    當 RepeatType 為 Permanent、None 時，RepeatEndTime 為空白。當 RepeatType 為 Daily、Weekly、Monthly 時，RepeatEndTime 必須有值，您需要設定重複結束時間。 時間格式為 HH:mm（24 小時制），例如 08:00、23:30。

    23:30
    StartTime

    integer

    存取控制策略的策略有效期間的開始時間。使用秒級時間戳記格式表示。必須為整點或半點鐘時間，且小於結束時間至少半小時。

    說明

    當 RepeatType 為 Permanent 時，StartTime 為空白。當 RepeatType 為 None、Daily、Weekly、Monthly 時，StartTime 必須有值，您需要設定開始時間。

    1694761200
    EndTime

    integer

    存取控制策略的策略有效期間的結束時間。使用秒級時間戳記格式表示。必須為整點或半點鐘時間，且大於開始時間至少半小時。

    說明

    當 RepeatType 為 Permanent 時，EndTime 為空白。當 RepeatType 為 None、Daily、Weekly、Monthly 時，EndTime 必須有值，您需要設定結束時間。

    1694764800

    樣本

    正常返回樣本

    JSON格式

    {
  "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 status code

    錯誤碼

    錯誤資訊

    描述
    400 ErrorParametersUid The aliUid parameter is invalid. aliUid 不合法
    400 ErrorParametersPageSizeOrNo Either pageSize or pageNo is invalid. 無效的pageSize或者pageNo
    400 ErrorParameterIpVersion The IP version is invalid. IP版本參數錯誤
    400 ErrorParametersDirection The direction is invalid. 無效的方向
    400 ErrorDBSelect An error occurred while querying database. 內部錯誤：資料庫查詢錯誤
    400 ErrorUnmarshalJSON An error occurred while parsing JSON. 內部錯誤：JSON解碼錯誤
    400 ErrorParametersAppId The AppId parameter is incorrect. AppId不正確
    400 ErrorParametersNatGatewayId Invalid parameters NatGatewayId. 請求參數NatGatewayId不合法或不存在。
    400 ErrorUUIDNew The UUID is invalid. 內部錯誤：UUID錯誤
    400 ErrorParametersSource The source is invalid. 無效的來源
    400 ErrorDomainResolve An error occurred while resolving the domain. 網域名稱解析錯誤
    400 ErrorParametersDestination The Destination parameter is invalid. Destination參數非法
    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. 內部錯誤：JSON編碼錯誤
    400 ErrorParametersAclUuid Specified parameter AclUuid is not valid. 指定的ACL uuid不合法。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。