調用DescribeControlPolicy擷取存取控制策略-Cloud Firewall-阿里雲 - Cloud Firewall

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

介面說明

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

QPS 限制

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

調試

您可以在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（預設）：中文 en：英文	zh
Direction	string	否	存取控制策略控制的流量方向。取值：in（外對內）或 out（內對外）。Direction 與 AclUuid 至少提供一個；未提供 AclUuid 時必須傳入非空 Direction，否則回傳 ErrorParametersDirection。枚舉值： in : 入方向，即外部存取內部的流量。 out : 出方向，即內部存取外部的流量。	in
CurrentPage	string	是	分頁查詢時，顯示的當前頁的頁碼。預設值為 1。	1
PageSize	string	是	分頁查詢時，顯示的每頁資料的最大筆數。	10
Source	string	否	存取控制策略中的存取來源位址。支援使用模糊查詢的方式進行查詢。SourceType（來源類型）不同，存取來源位址的取值也不同。當 SourceType 為`net`時，存取來源為 CIDR 格式的 IP 位址段。例如：192.0.XX.XX/24。當 SourceType 為`group`時，存取來源為來源位址簿名稱。例如：db_group 為空（表示查詢所有存取控制來源）。當 SourceType 為`location`時，存取來源為來源區域。例如：北京或 beijing（支援使用中文或英文進行查詢）。說明不設定該參數表示查詢所有類型的存取來源。	192.0.XX.XX
Destination	string	否	存取控制策略中的目的位址。支援模糊查詢。DestinationType（目的類型）不同，目的位址的取值也不同。當 DestinationType 為`net`時，目的位址為 CIDR 格式的 IP 位址段。例如：10.0.3.0/24。當 DestinationType 為`domain`時，目的位址為網域名稱。例如：aliyun。當 DestinationType 為`group`時，目的位址為位址簿的名稱。例如：db_group。當 DestinationType 為`location`時，目的位址為區域名稱（具體區域位置編碼請參見 AddControlPolicy）。例如：["BJ11", "ZB"]。說明不設定該參數表示查詢所有類型的目的位址。	192.0.XX.XX
Description	string	否	存取控制策略的描述資訊。支援模糊查詢。說明不設定該參數表示查詢所有策略的描述資訊。	允許存取辦公網段
Proto	string	否	存取控制策略中存取流量的通訊協定類型。取值： TCP UDP ICMP ANY（表示所有通訊協定類型）說明不設定該參數表示查詢所有通訊協定類型。	TCP
AclAction	string	否	存取控制策略中設定的流量通過雲端防火牆的方式（動作）。取值： accept：放行 drop：拒絕 log：觀察說明不設定該參數表示查詢所有的動作類型。	accept
Release	string	否	存取控制策略的啟用狀態。取值： true：啟用存取控制策略 false：不啟用存取控制策略	true
AclUuid	string	否	存取控制策略的唯一標識 ID。AclUuid 與 Direction 至少提供一個；指定 AclUuid 時可按策略 ID 查詢。	00281255-d220-4db1-8f4f-c4df221a****
IpVersion	string	否	支援的 IP 位址版本。取值： 4（預設）：代表 IPv4 位址 6：代表 IPv6 位址枚舉值： 4 : IPv4 6 : IPv6	6
RepeatType	string	否	存取控制策略的策略有效期的重複類型。取值： Permanent（預設）：總是 None：指定單次時間 Daily：每天 Weekly：每週 Monthly：每月枚舉值： 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：外對內流量存取控制 out：內對外流量存取控制	in
Order	integer	存取控制策略生效的優先順序。優先順序數字從 1 開始順序遞增，優先順序數字越小，優先順序越高。	1
SourceType	string	存取控制策略中的來源位址類型。取值： net：來源網段（CIDR 位址） group：來源位址簿 location：來源區域	net
ApplicationName	string	存取控制策略支援的應用程式類型，推薦使用 ApplicationNameList。取值： FTP HTTP HTTPS Memcache MongoDB MQTT MySQL RDP Redis SMTP SMTPS SSH SSL VNC ANY（表示所有應用程式類型）	HTTP
HitTimes	integer	存取控制策略的命中次數。	100
Description	string	存取控制策略的描述資訊。	允許存取辦公網段
SourceGroupType	string	存取控制策略中的來源位址簿類型。取值： ip：IP 位址簿，包含一個或多個 IP 位址段。 tag：ECS 標籤位址簿，包含一個或多個 ECS 標籤下的 IP 位址。 domain：網域名稱位址簿，包含一個或多個網域名稱位址。 threat：威脅位址簿，包含一個或多個惡意 IP 或網域名稱位址。 backsrc：回源位址簿，包含一個或多個 DDoS 防護執行個體或 WAF 執行個體的回源位址。	ip
DnsResultTime	integer	DNS 解析的時間戳記。使用秒級時間戳記格式表示。	1579261141
DnsResult `deprecated`	string	DNS 解析結果。	192.0.XX.XX,192.0.XX.XX
Proto	string	存取控制策略中流量存取的安全通訊協定類型。取值： ANY TCP UDP ICMP	TCP
DestinationGroupType	string	存取控制策略中的目的位址簿類型。取值： ip：IP 位址簿，包含一個或多個 IP 位址段。 tag：ECS 標籤位址簿，包含一個或多個 ECS 標籤下的 IP 位址。 domain：網域名稱位址簿，包含一個或多個網域名稱位址。 threat：威脅位址簿，包含一個或多個惡意 IP 或網域名稱位址。 backsrc：回源位址簿，包含一個或多個 DDoS 防護執行個體或 WAF 執行個體的回源位址。	ip
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"]。	192.0.XX.XX/24
HitLastTime	integer	最新命中時間戳記。使用秒級時間戳記格式表示。	1579261141
DestPortGroup	string	存取控制策略中流量存取的目的連接埠位址簿名稱。	my_port_group
AclUuid	string	存取控制策略的唯一標識 ID。	00281255-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
DestPort	string	存取控制策略中存取流量的目的連接埠。	80
IpVersion	integer	支援的 IP 位址版本。取值： 4：代表 IPv4 位址 6：代表 IPv6 位址	6
AclAction	string	存取控制策略中設定的流量通過雲端防火牆的方式（動作）。取值： accept：放行 drop：拒絕 log：觀察	accept
Release	string	存取控制策略的啟用狀態。策略建立後預設啟用該策略。取值： true：啟用存取控制策略 false：不啟用存取控制策略	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	存取控制策略支援的應用程式類型清單。取值： FTP HTTP HTTPS Memcache MongoDB MQTT MySQL RDP Redis SMTP SMTPS SSH SSL VNC ANY（表示所有應用程式類型）	HTTP
SpreadCnt	integer	佔用存取控制策略的規格數，即每條策略佔用規格數的累加值。單條策略佔用的規格數 = 來源位址個數（IP 位址段個數或區域個數）* 目的位址個數（IP 位址段個數或區域個數或網域名稱個數）* 連接埠段個數 * 應用程式數。	10000
CreateTime	integer	建立策略的時間。使用秒級 Unix 時間戳記表示，即從 1970 年 1 月 1 日（UTC）起經過的秒數。	1761062400
ModifyTime	integer	修改策略的時間。使用秒級 Unix 時間戳記表示，即從 1970 年 1 月 1 日（UTC）起經過的秒數。	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	存取控制策略的策略有效期的重複開始時間。例如：08:00，必須為整點或半點時間，且小於重複結束時間至少半小時。說明當 RepeatType 為 Permanent、None 時，RepeatStartTime 為空。當 RepeatType 為 Daily、Weekly、Monthly 時，RepeatStartTime 必須有值，您需要設定重複開始時間。時間格式為 HH:mm（24 小時制），例如 08:00、23:30。	08:00
RepeatEndTime	string	存取控制策略的策略有效期的重複結束時間。例如：23:30，必須為整點或半點時間，且大於重複開始時間至少半小時。說明當 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
DomainResolveType	string	存取控制策略的網域名稱解析方式。取值： FQDN：基於 FQDN DNS：基於 DNS 動態解析 FQDN_AND_DNS：基於 FQDN 與 DNS 動態解析	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": "允許存取辦公網段",
      "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.	無效的 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	ErrorUUIDNew	The UUID is invalid.	內部錯誤：UUID 錯誤。
400	ErrorParametersAppId	The AppId parameter is incorrect.	無效的 AppId。
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.	A parameter error occurred.
400	ErrorMarshalJSON	An error occurred while encoding JSON.	內部錯誤：JSON編碼錯誤。
400	ErrorParametersAclUuid	Specified parameter AclUuid is not valid.	指定的 ACL uuid 不合法。

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

變更歷史

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