調用DescribePrefixLists介面查詢首碼列表-Cloud Firewall-阿里雲 - Cloud Firewall

查詢首碼列表。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-cloudfirewall:DescribePrefixLists

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
SourceIp	string	否	訪問者源 IP 位址。	47.100.XX.XX
RegionNo	string	是	執行個體所在的地區 ID。	cn-shenzhen

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	返回結果的請求 ID。	67FD76C2-C493-5815-8107-643FD7AB77C7
PrefixList	array<object>	首碼列表資訊組成的數組。
	object	首碼列表資訊組成的數組。
PrefixListId	string	首碼列表 ID。	pl-uf64nco3ujjqchx6aaji
PrefixListName	string	首碼列表的名稱。	participant-name
Description	string	描述。	TCP_14900-14911
CreationTime	string	首碼列表的建立時間。使用 ISO 8601 格式 yyyy-MM-ddTHH:mm:ssZ 表示。	2023-10-16T08:31:06Z
AssociationCount	integer	關聯資源的數量。	2
MaxEntries	integer	首碼列表支援的最大條目容量。	20
AddressFamily	string	首碼列表的地址族。可能值： IPv4。 IPv6。	IPv4

樣本

正常返回樣本

JSON格式

{
  "RequestId": "67FD76C2-C493-5815-8107-643FD7AB77C7",
  "PrefixList": [
    {
      "PrefixListId": "pl-uf64nco3ujjqchx6aaji",
      "PrefixListName": "participant-name",
      "Description": "TCP_14900-14911",
      "CreationTime": "2023-10-16T08:31:06Z",
      "AssociationCount": 2,
      "MaxEntries": 20,
      "AddressFamily": "IPv4"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	ErrorParameters	parameters invalid.	參數錯誤，請檢查後重試。
400	ErrorMarshalJSON	An error occurred while encoding JSON.	內部錯誤：JSON編碼錯誤

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

變更歷史

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