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

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

介面說明

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

QPS 限制

本介面的單使用者 QPS 限制為 10 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
Lang	string	否	請求和接收訊息的語言類型。取值： zh（預設）：中文 en：英文	zh
VpcFirewallId	string	是	VPC 邊界防火牆的執行個體 ID。取值：當 VPC 邊界防火牆防護通過雲企業網串連的兩個 VPC 之間的流量時，該參數值使用雲企業網執行個體 ID。當 VPC 邊界防火牆防護通過Express Connect串連的兩個 VPC 之間的流量時，該參數值使用 VPC 邊界防火牆執行個體 ID。說明您可以調用 DescribeVpcFirewallAclGroupList 介面擷取該 ID。	vfw-a42bbb7b887148c9****
CurrentPage	string	否	分頁查詢時，設定當前頁的頁碼。	1
PageSize	string	否	分頁查詢時，設定每頁包含 VPC 邊界防火牆的存取控制策略數量。可設定值最大為 50。	10
Source	string	否	VPC 邊界防火牆存取控制策略中的訪問源地址。支援使用模糊查詢。說明 Source 可以是單個 CIDR 地址或地址簿名稱。	192.0.XX.XX/24
Destination	string	否	VPC 邊界防火牆存取控制策略中的目的地址。支援模糊查詢。說明 Destination 可以是單個 CIDR 地址或網域名稱，也可以是地址薄名稱。	192.0.XX.XX/24
Description	string	否	VPC 邊界防火牆存取控制策略的描述資訊。支援模糊查詢。	test
Proto	string	否	VPC 邊界防火牆存取控制策略中訪問流量的協議類型。取值： TCP UDP ICMP ANY（查詢所有協議類型）說明不設定該參數表示查詢所有協議類型。	TCP
AclAction	string	否	VPC 邊界防火牆存取控制策略中設定的訪問流量通過Cloud Firewall的方式（動作）。取值： accept：允許存取 drop：拒絕 log：觀察說明不設定該參數表示查詢所有動作。	accept
MemberUid	string	否	當前阿里雲帳號的成員帳號 UID。	258039427902****
AclUuid	string	否	VPC 邊界防火牆存取控制策略的唯一標識 ID。	4037fbf7-3e39-4634-92a4-d0155247****
Release	string	否	存取控制策略的啟用狀態。取值： true：啟用存取控制策略 false：不啟用存取控制策略	true
RepeatType	string	否	存取控制策略的策略有效期間的重複類型。取值： Permanent（預設）：總是 None：指定單次時間 Daily：每天 Weekly：每周 Monthly：每月枚舉值： 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 邊界防火牆存取控制策略中的目的地址。取值：當 DestinationType 為`net`時，Destination 為目的 CIDR 地址。當 DestinationType 為`domain`時，Destination 為目的網域名稱。當 DestinationType 為`group`時，Destination 為目的地址簿名稱。	192.0.XX.XX/24
Order	integer	VPC 邊界防火牆存取控制策略生效的優先順序。優先順序數字從 1 開始順序遞增，優先順序數字越小，表示優先順序越高。	1
DestPortGroup	string	VPC 邊界防火牆存取控制策略中訪問流量的目的連接埠地址簿名稱。	my_port_group
SourceType	string	VPC 邊界防火牆存取控制策略中源地址類型。取值： net：源 CIDR 地址 group：源地址簿	net
ApplicationName	string	VPC 邊界防火牆存取控制策略支援的應用類型，推薦使用 ApplicationNameList。取值： HTTP HTTPS MySQL SMTP SMTPS RDP VNC SSH Redis MQTT MongoDB Memcache SSL ANY（表示查詢存取控制策略所有的應用類型）	HTTP
AclUuid	string	VPC 邊界防火牆存取控制策略的唯一標識 ID。	4037fbf7-3e39-4634-92a4-d0155247****
DestPortType	string	VPC 邊界防火牆存取控制策略中訪問流量的目的連接埠類型。取值： port：單個連接埠 group：連接埠地址簿	port
Source	string	VPC 邊界防火牆存取控制策略中的訪問源地址。取值：當 SourceType 為`net`時，Source 為訪問源 CIDR 地址。當 SourceType 為`group`時，Source 為地址簿名稱。	192.0.XX.XX/24
DestinationType	string	VPC 邊界防火牆存取控制策略中目的地址的類型。取值： net：目的 CIDR 地址 group：目的地址簿 domain：目的網域名稱	net
HitTimes	integer	VPC 邊界防火牆存取控制策略的叫用次數。	100
DestPort	string	VPC 邊界防火牆存取控制策略中訪問流量的目的連接埠。	80
Description	string	VPC 邊界防火牆存取控制策略的描述資訊。	test
AclAction	string	VPC 邊界防火牆存取控制策略中設定的訪問流量通過Cloud Firewall的方式（動作）。取值： accept：允許存取 drop：拒絕 log：觀察	accept
ApplicationId	string	VPC 邊界防火牆存取控制策略中設定訪問流量的應用的 ID。	10**
Proto	string	VPC 邊界防火牆存取控制策略中訪問流量的協議類型。取值： TCP UDP ICMP ANY（表示查詢所有協議類型）	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：啟用存取控制策略 false：不啟用存取控制策略	true
SourceGroupType	string	存取控制策略中的源地址簿類型。唯一取值： ip。表示 IP 位址簿，包含一個或多個 IP 位址段。	ip
DestinationGroupType	string	存取控制策略中的目的地址簿類型。取值： ip：IP 位址簿，包含一個或多個 IP 位址段。 domain：網域名稱地址簿，包含一個或多個網域名稱地址。	ip
HitLastTime	integer	最新命中時間戳記。使用秒級時間戳記格式表示。	1579261141
ModifyTime	integer	修改策略的時間。使用秒級時間戳記格式表示。	1761062400
SpreadCnt	integer	佔用存取控制策略的規格數，即每條策略佔用規格數的累加值。單條策略佔用存取控制策略的規格數=訪問源位址區段個數 * 目的地址個數（IP 位址段個數或網域名稱個數）* 應用數 * 連接埠段個數。	10,000
CreateTime	integer	建立策略的時間。使用秒級時間戳記格式表示。	1761062400
ApplicationNameList	array	應用程式名稱列表。
	string	VPC 邊界防火牆存取控制策略支援的應用類型列表。取值： HTTP HTTPS MySQL SMTP SMTPS RDP VNC SSH Redis MQTT MongoDB Memcache SSL ANY（表示查詢存取控制策略所有的應用類型）	[ "HTTPS", "SMTPS", "SSL" ]
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	存取控制策略的策略有效期間的重複開始時間。例如：08:00，必須為整點或半點鐘時間，且小於重複結束時間至少半小時。說明當 RepeatType 為 Permanent、None 時，RepeatStartTime 為空白。當 RepeatType 為 Daily、Weekly、Monthly 時，RepeatStartTime 必須有值，您需要設定重複開始時間。	08:00
RepeatEndTime	string	存取控制策略的策略有效期間的重複結束時間。例如：23:30，必須為整點或半點鐘時間，且大於重複開始時間至少半小時。說明當 RepeatType 為 Permanent、None 時，RepeatEndTime 為空白。當 RepeatType 為 Daily、Weekly、Monthly 時，RepeatEndTime 必須有值，您需要設定重複結束時間。	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
DomainResolveType	string	存取控制策略的網域名稱解析方式。取值： FQDN：基於 FQDN DNS：基於 DNS 動態解析 FQDN_AND_DNS：基於 FQDN 與 DNS 動態解析	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": 0,
      "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.	aliUid 不合法
400	ErrorParametersPageSizeOrNo	Either pageSize or pageNo is invalid.	無效的pageSize或者pageNo
400	ErrorDBSelect	An error occurred while querying database.	內部錯誤：資料庫查詢錯誤
400	ErrorUUIDNew	The UUID is invalid.	內部錯誤：UUID錯誤
400	ErrorParametersAppId	The appId is invalid.	無效的AppId
400	ErrorParameterIpVersion	The IP version is invalid.	IP版本參數錯誤
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.	Destination參數非法
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.	內部錯誤：JSON編碼錯誤
400	ErrorParametersAclUuid	Specified parameter AclUuid is not valid.	指定的ACL uuid不合法。

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

變更歷史

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