全部產品
Search
文件中心

Cloud Firewall:DescribeVpcFirewallControlPolicy

更新時間:Jul 24, 2026

查詢指定的 VPC 邊界防火牆的所有存取控制策略資訊。

介面說明

本介面一般用於查詢 VPC 邊界防火牆的存取控制策略。VPC 邊界防火牆防護透過雲企業網連接的兩個 VPC 之間的流量或防護透過高速通道連接的兩個 VPC 之間的流量時,使用不同的存取控制策略。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-cloudfirewall:DescribeVpcFirewallControlPolicy

get

*VpcFirewallControlPolicy

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

*VpcFirewall

acs:cloudfirewall::{#accountId}:vpcfirewall/{#VpcFirewallId}

無 無

請求參數

名稱

類型

必填

描述

樣本值

Lang

string

否

請求和接收訊息的語言類型。

zh

VpcFirewallId

string

是

VPC 邊界防火牆的執行個體 ID。取值:

vfw-a42bbb7b887148c9****

CurrentPage

string

否

分頁查詢時,設定目前頁的頁碼。

1

PageSize

string

否

分頁查詢時,設定每頁包含 VPC 邊界防火牆的存取控制策略數量。

10

Source

string

否

VPC 邊界防火牆存取控制策略中的存取來源位址。支援使用模糊查詢。

192.0.XX.XX/24

Destination

string

否

VPC 邊界防火牆存取控制策略中的目的位址。支援模糊查詢。

192.0.XX.XX/24

Description

string

否

VPC 邊界防火牆存取控制策略的描述資訊。支援模糊查詢。

test

Proto

string

否

VPC 邊界防火牆存取控制策略中存取流量的通訊協定類型。取值:

TCP

AclAction

string

否

VPC 邊界防火牆存取控制策略中設定的存取流量通過雲端防火牆的方式(動作)。取值:

accept

MemberUid

string

否

當前阿里雲帳號的成員帳號 UID。

258039427902****

AclUuid

string

否

VPC 邊界防火牆存取控制策略的唯一識別碼 ID。

4037fbf7-3e39-4634-92a4-d0155247****

Release

string

否

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

true

RepeatType

string

否

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

枚舉值:

  • Daily :

    每天。

  • Monthly :

    每月。

  • Permanent :

    總是。

  • Weekly :

    每週。

  • None :

    指定單次時間。

Permanent

返回參數

名稱

類型

描述

樣本值

object

TotalCount

string

VPC 邊界防火牆存取控制策略的總數量。

20

RequestId

string

本次請求的 ID。

CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D

Policys

array<object>

VPC 邊界防火牆存取控制策略的資訊。

object

Destination

string

VPC 邊界防火牆存取控制策略中的目的位址。取值:

192.0.XX.XX/24

Order

integer

VPC 邊界防火牆存取控制策略生效的優先順序。

1

DestPortGroup

string

VPC 邊界防火牆存取控制策略中存取流量的目的連接埠通訊錄名稱。

my_port_group

SourceType

string

VPC 邊界防火牆存取控制策略中來源位址類型。取值:

net

ApplicationName

string

VPC 邊界防火牆存取控制策略支援的應用程式類型,推薦使用 ApplicationNameList。取值:

HTTP

AclUuid

string

VPC 邊界防火牆存取控制策略的唯一識別碼 ID。

4037fbf7-3e39-4634-92a4-d0155247****

DestPortType

string

VPC 邊界防火牆存取控制策略中存取流量的目的連接埠類型。取值:

port

Source

string

VPC 邊界防火牆存取控制策略中的存取來源位址。取值:

192.0.XX.XX/24

DestinationType

string

VPC 邊界防火牆存取控制策略中目的位址的類型。取值:

net

HitTimes

integer

VPC 邊界防火牆存取控制策略的命中次數。

100

DestPort

string

VPC 邊界防火牆存取控制策略中存取流量的目的連接埠。

80

Description

string

VPC 邊界防火牆存取控制策略的描述資訊。

test

AclAction

string

VPC 邊界防火牆存取控制策略中設定的存取流量通過雲端防火牆的方式(動作)。取值:

accept

ApplicationId

string

VPC 邊界防火牆存取控制策略中設定存取流量的應用程式的 ID。

10**

Proto

string

VPC 邊界防火牆存取控制策略中存取流量的通訊協定類型。取值:

TCP

DestinationGroupCidrs

array

VPC 邊界防火牆存取控制策略中目的通訊錄中的網段資訊。

string

VPC 邊界防火牆存取控制策略中目的通訊錄中的網段清單。

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

DestPortGroupPorts

array

VPC 邊界防火牆存取控制策略中目的連接埠通訊錄的詳細資訊。

string

VPC 邊界防火牆存取控制策略中目的連接埠通訊錄中包含的連接埠清單。

[80,443]

SourceGroupCidrs

array

VPC 邊界防火牆存取控制策略中來源通訊錄的詳細資訊。

string

VPC 邊界防火牆存取控制策略中,來源通訊錄中的網段清單。

["192.0.XX.XX/24", "198.51.XX.XX/32"]

MemberUid

string

當前阿里雲帳號的成員帳號 UID。

258039427902****

Release

string

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

true

SourceGroupType

string

存取控制策略中的來源通訊錄類型。唯一取值:ip。表示 IP 通訊錄,包含一個或多個 IP 位址段。

ip

DestinationGroupType

string

存取控制策略中的目的通訊錄類型。取值:

ip

HitLastTime

integer

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

1579261141

ModifyTime

integer

修改策略的時間。使用秒級時間戳記格式表示。

1761062400

SpreadCnt

integer

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

10000

CreateTime

integer

建立策略的時間。使用秒級時間戳記格式表示。

1761062400

ApplicationNameList

array

應用程式名稱清單。

string

VPC 邊界防火牆存取控制策略支援的應用程式類型清單。取值:

[ "HTTPS", "SMTPS", "SSL" ]

RepeatType

string

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

枚舉值:

  • Daily :

    每天。

  • Monthly :

    每月。

  • Permanent :

    總是。

  • Weekly :

    每週。

  • None :

    指定單次時間。

Permanent

RepeatDays

array

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

integer

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

1

RepeatStartTime

string

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

08:00

RepeatEndTime

string

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

23:30

StartTime

integer

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

1694761200

EndTime

integer

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

1694764800

DomainResolveType

string

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

FQDN

樣本

正常返回樣本

JSON格式

{
  "TotalCount": "20",
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D",
  "Policys": [
    {
      "Destination": "192.0.XX.XX/24",
      "Order": 1,
      "DestPortGroup": "my_port_group",
      "SourceType": "net",
      "ApplicationName": "HTTP",
      "AclUuid": "4037fbf7-3e39-4634-92a4-d0155247****",
      "DestPortType": "port",
      "Source": "192.0.XX.XX/24",
      "DestinationType": "net",
      "HitTimes": 100,
      "DestPort": "80",
      "Description": "test",
      "AclAction": "accept",
      "ApplicationId": "10**",
      "Proto": "TCP",
      "DestinationGroupCidrs": [
        "[\"192.0.XX.XX/24\", \"192.0.XX.XX/32\"]"
      ],
      "DestPortGroupPorts": [
        "[80,443]"
      ],
      "SourceGroupCidrs": [
        "[\"192.0.XX.XX/24\", \"198.51.XX.XX/32\"]"
      ],
      "MemberUid": "258039427902****",
      "Release": "true",
      "SourceGroupType": "ip",
      "DestinationGroupType": "ip",
      "HitLastTime": 1579261141,
      "ModifyTime": 1761062400,
      "SpreadCnt": 10000,
      "CreateTime": 1761062400,
      "ApplicationNameList": [
        "[\n    \"HTTPS\", \n    \"SMTPS\", \n    \"SSL\"\n]"
      ],
      "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 ErrorDBSelect An error occurred while querying database.
400 ErrorUUIDNew The UUID is invalid.
400 ErrorParametersAppId The appId is invalid.
400 ErrorParameterIpVersion The IP version is invalid.
400 ErrorParametersDirection The direction is invalid.
400 ErrorParametersSource The source is invalid.
400 ErrorDomainResolve A domain resolution error occurred.
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.

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

變更歷史

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