全部產品
Search

搜尋本產品

    Cloud Firewall：DescribeControlPolicy

    文件中心

    Cloud Firewall：DescribeControlPolicy

    更新時間：Aug 02, 2026

    取得所有存取控制策略的資訊。

    介面說明

    此介面一般用於分頁查詢存取控制策略的資訊。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    yundun-cloudfirewall:DescribeControlPolicy

    get

    *ControlPolicyOrder

    acs:cloudfirewall::{#accountId}:controlpolicy/{#AclUuid}/controlpolicyorder/{#Direction}

    *ControlPolicy

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Lang

    string

    否

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

    zh
    Direction

    string

    否

    存取控制策略控制的流量方向。取值：in（外對內）或 out（內對外）。Direction 與 AclUuid 至少提供一個；未提供 AclUuid 時必須傳入非空 Direction，否則返回 ErrorParametersDirection。

    枚舉值：

    • in :

      入方向，即外部存取內部的流量。

    • out :

      出方向，即內部存取外部的流量。

    in
    CurrentPage

    string

    是

    分頁查詢時，顯示的目前頁碼。

    1
    PageSize

    string

    是

    分頁查詢時，顯示的每頁資料最大筆數。

    10
    Source

    string

    否

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

    192.0.XX.XX
    Destination

    string

    否

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

    192.0.XX.XX
    Description

    string

    否

    存取控制策略的描述資訊。支援模糊查詢。

    允許存取辦公網段
    Proto

    string

    否

    存取控制策略中存取流量的通訊協定類型。取值：

    TCP
    AclAction

    string

    否

    存取控制策略中設定的流量通過雲端防火牆的方式（動作）。取值：

    accept
    Release

    string

    否

    存取控制策略的啟用狀態。取值：

    true
    AclUuid

    string

    否

    存取控制策略的唯一識別碼 ID。AclUuid 與 Direction 至少提供一個；指定 AclUuid 時可按策略 ID 查詢。

    00281255-d220-4db1-8f4f-c4df221a****
    IpVersion

    string

    否

    支援的 IP 位址版本。取值：

    枚舉值：

    • 4 :

      IPv4

    • 6 :

      IPv6

    6
    RepeatType

    string

    否

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

    枚舉值：

    • Daily :

      每天。

    • Monthly :

      每月。

    • Permanent :

      總是。

    • Weekly :

      每週。

    • None :

      指定單次時間。

    Permanent

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    PageNo

    string

    分頁查詢時，顯示的目前頁碼。

    1
    PageSize

    string

    分頁查詢時，顯示的每頁資料最大筆數。

    10
    RequestId

    string

    結果的請求 ID。

    CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****
    TotalCount

    string

    存取控制策略的總數量。

    100
    Policys

    array<object>

    存取控制策略的資訊。

    object

    存取控制策略的詳細資訊。

    Direction

    string

    存取控制策略的流量方向。取值：

    in
    Order

    integer

    存取控制策略生效的優先順序。

    1
    SourceType

    string

    存取控制策略中的來源位址類型。取值：

    net
    ApplicationName

    string

    存取控制策略支援的應用程式類型，建議使用 ApplicationNameList。取值：

    HTTP
    HitTimes

    integer

    存取控制策略的命中次數。

    100
    Description

    string

    存取控制策略的描述資訊。

    允許存取辦公網段
    SourceGroupType

    string

    存取控制策略中的來源位址簿類型。取值：

    ip
    DnsResultTime

    integer

    DNS 解析的時間戳記。使用秒級時間戳記格式表示。

    1579261141
    DnsResult deprecated

    string

    DNS 解析結果。

    192.0.XX.XX,192.0.XX.XX
    Proto

    string

    存取控制策略中流量存取的安全通訊協定類型。取值：

    TCP
    DestinationGroupType

    string

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

    ip
    Destination

    string

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

    192.0.XX.XX/24
    HitLastTime

    integer

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

    1579261141
    DestPortGroup

    string

    存取控制策略中流量存取的目的連接埠位址簿名稱。

    my_port_group
    AclUuid

    string

    存取控制策略的唯一識別碼 ID。

    00281255-d220-4db1-8f4f-c4df221a****
    DestPortType

    string

    存取控制策略中流量存取的目的連接埠類型。取值：

    port
    Source

    string

    存取控制策略中的存取來源位址。取值：

    192.0.XX.XX/24
    DestinationType

    string

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

    net
    DestPort

    string

    存取控制策略中存取流量的目的連接埠。

    80
    IpVersion

    integer

    支援的 IP 位址版本。取值：

    6
    AclAction

    string

    存取控制策略中設定的流量通過雲端防火牆的方式（動作）。取值：

    accept
    Release

    string

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

    true
    ApplicationId

    string

    存取控制策略中設定存取流量的應用程式 ID。

    10***
    DestinationGroupCidrs

    array

    存取控制策略中的目的位址簿中的網段清單。

    string

    存取控制策略中的目的位址簿中的網段。

    192.0.XX.XX/24
    DestPortGroupPorts

    array

    目的連接埠位址簿中包含的連接埠清單。

    string

    目的連接埠位址簿中包含的連接埠。

    80/80
    SourceGroupCidrs

    array

    存取控制策略中的來源位址簿中的網段清單。

    string

    存取控制策略中的來源位址簿中的網段。

    192.0.XX.XX/24
    ApplicationNameList

    array

    應用程式名稱清單。

    string

    存取控制策略支援的應用程式類型清單。取值：

    HTTP
    SpreadCnt

    integer

    佔用存取控制策略的規格數，即每條策略佔用規格數的累加值。

    10000
    CreateTime

    integer

    建立策略的時間。使用秒級 Unix 時間戳記表示，即從 1970 年 1 月 1 日（UTC）起經過的秒數。

    1761062400
    ModifyTime

    integer

    修改策略的時間。使用秒級 Unix 時間戳記表示，即從 1970 年 1 月 1 日（UTC）起經過的秒數。

    1761062400
    RepeatType

    string

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

    枚舉值：

    • Daily :

      每天。

    • Monthly :

      每月。

    • Permanent :

      總是。

    • Weekly :

      每週。

    • None :

      指定單次時間。

    Permanent
    RepeatDays

    array

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

    integer

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

    1
    RepeatStartTime

    string

    存取控制策略的策略有效期的重複開始時間。例如：08:00，必須為整點或半點時間，且小於重複結束時間至少半小時。

    08:00
    RepeatEndTime

    string

    存取控制策略的策略有效期的重複結束時間。例如：23:30，必須為整點或半點時間，且大於重複開始時間至少半小時。

    23:30
    StartTime

    integer

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

    1694761200
    EndTime

    integer

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

    1694764800
    DomainResolveType

    string

    存取控制策略的網域名稱解析方式。取值：

    FQDN

    樣本

    正常返回樣本

    JSON格式

    {
  "PageNo": "1",
  "PageSize": "10",
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****",
  "TotalCount": "100",
  "Policys": [
    {
      "Direction": "in",
      "Order": 1,
      "SourceType": "net",
      "ApplicationName": "HTTP",
      "HitTimes": 100,
      "Description": "test",
      "SourceGroupType": "ip",
      "DnsResultTime": 1579261141,
      "DnsResult": "192.0.XX.XX,192.0.XX.XX",
      "Proto": "TCP",
      "DestinationGroupType": "ip",
      "Destination": "192.0.XX.XX/24",
      "HitLastTime": 1579261141,
      "DestPortGroup": "my_port_group",
      "AclUuid": "00281255-d220-4db1-8f4f-c4df221a****",
      "DestPortType": "port",
      "Source": "192.0.XX.XX/24",
      "DestinationType": "net",
      "DestPort": "80",
      "IpVersion": 6,
      "AclAction": "accept",
      "Release": "true",
      "ApplicationId": "10***",
      "DestinationGroupCidrs": [
        "192.0.XX.XX/24"
      ],
      "DestPortGroupPorts": [
        "80/80"
      ],
      "SourceGroupCidrs": [
        "192.0.XX.XX/24"
      ],
      "ApplicationNameList": [
        "HTTP"
      ],
      "SpreadCnt": 10000,
      "CreateTime": 1761062400,
      "ModifyTime": 1761062400,
      "RepeatType": "Permanent",
      "RepeatDays": [
        1
      ],
      "RepeatStartTime": "08:00",
      "RepeatEndTime": "23:30",
      "StartTime": 1694761200,
      "EndTime": 1694764800,
      "DomainResolveType": "FQDN"
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    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 ErrorUUIDNew The UUID is invalid.
    400 ErrorParametersAppId The AppId parameter is incorrect.
    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 ErrorParameters Parameters error.
    400 ErrorMarshalJSON An error occurred while encoding JSON.
    400 ErrorParametersAclUuid Specified parameter AclUuid is not valid.

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

    變更歷史

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