CreatePrefixList - 建立首碼列表 - Elastic Compute Service

建立一個首碼列表。

介面說明

首碼列表是一些網路首碼（即 CIDR 地址塊）的集合，您可以在配置其他資源的網路規則時引用首碼列表。關於首碼列表的詳細說明，請參見首碼列表概述。
建立首碼列表時：
- 您必須為該首碼列表指定地址族（IPv4 或 IPv6），同一首碼列表中的條目只能屬於同一地址族，且地址族建立後不能修改。
- 您必須為該首碼列表設定最大條目容量，且建立後不能修改。
- 您可以為該首碼列表指定一些條目，條目由 CIDR 地址塊和描述構成，條目數量不能超過您設定的最大條目容量。
關於首碼列表及其他資源的使用限制說明，請參見使用限制。
通過 RAM 使用者可以讓您避免與其他使用者共用阿里雲帳號密鑰，按需為使用者指派最小許可權，從而降低企業的資訊安全風險。關於如何為 RAM 使用者授予首碼列表相關許可權的具體操作，請參見為 RAM 使用者授予首碼列表相關許可權。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:CreatePrefixList

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID。	cn-chengdu
RegionId	string	是	地區 ID。	cn-chengdu
MaxEntries	integer	是	首碼列表支援的最大條目容量。取值範圍：1~200。	10
AddressFamily	string	是	首碼列表的地址族。取值範圍： IPv4。 IPv6。	IPv4
ClientToken	string	否	保證請求等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。`ClientToken`只支援 ASCII 字元，且不能超過 64 個字元。更多資訊，請參見如何保證等冪性。	0c593ea1-3bea-11e9-b96b-88e9fe637760
PrefixListName	string	是	首碼列表的名稱。長度為 2~128 個字元，必須以大小字母或中文開頭，不能以`http://`、`https://`、`com.aliyun`和`com.alibabacloud`開頭。可以包含中文、英文、數字、半形冒號（:）、底線（_）、半形句號（.）或者短劃線（-）。	PrefixListNameSample
Description	string	否	首碼列表的描述資訊。長度為 2~256 個英文或中文字元，不能以`http://`和`https://`開頭。	This is description.
Entry	array<object>	否	首碼列表條目資訊。
	object	否
Description	string	否	首碼列表條目的描述資訊。長度為 2~32 個英文或中文字元，不能以`http://`和`https://`開頭。N 的取值範圍：0~200。	Description Sample 01
Cidr	string	是	首碼列表條目的 CIDR 地址塊資訊。N 的取值範圍：0~200。注意事項：首碼列表的條目數量不能大於最大條目容量（`MaxEntries`）。條目中的 CIDR 地址塊類型根據地址族決定，一個首碼列表不能同時包含 IPv4 和 IPv6 的 CIDR 地址塊。多個條目中的 CIDR 地址塊不能重複。例如，您不能設定兩個 192.168.1.0/24。支援設定單 IP 位址，系統會自動轉換為 CIDR 地址塊。例如，您設定 192.168.1.100，系統會自動轉換成 192.168.1.100/32。如果使用 IPv6 CIDR 地址塊，系統會自動轉換成零壓縮表示形式且字母轉換為小寫。例如，您設定 2001:0DB8:0000:0000:0000:0000:0000:0000/32，系統會自動轉換成 2001:db8::/32。關於 CIDR 地址塊的詳細資料，請參見什麼是 CIDR。預設值：空。	192.168.1.0/24
Tag	array<object>	否	標籤列表。
	object	否	標籤列表。
Key	string	否	首碼列表的標籤鍵。N 的取值範圍：1~20。一旦傳入該值，則不允許為空白字串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	TestKey
Value	string	否	首碼列表的標籤值。N 的取值範圍：1~20。該值可以為空白字串。最多支援 128 個字元，不能包含`http://或 https://`。	TestValue
ResourceGroupId	string	否	首碼列表所屬的企業資源組 ID。	rg-bp67acfmxazb4p****

返回參數

名稱	類型	描述	樣本值
	object
PrefixListId	string	首碼列表 ID。	pl-x1j1k5ykzqlixdcy****
RequestId	string	請求 ID。	38793DB8-A4B2-4AEC-BFD3-111234E9188D

樣本

正常返回樣本

JSON格式

{
  "PrefixListId": "pl-x1j1k5ykzqlixdcy****",
  "RequestId": "38793DB8-A4B2-4AEC-BFD3-111234E9188D"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	MissingParameter	%s	缺失參數，請檢查參數是否完整。
400	InvalidParameter.AddressFamily	The parameter AddressFamily should be IPv4 or IPv6.	地址族應為IPv4或IPv6。
400	InvalidParameter	%s	無效的參數。
400	InvalidParameter.PrefixListName	The parameter PrefixListName is not valid.	首碼列表名稱不合法。
400	InvalidDescription.Malformed	The specified Description is wrongly formed.
400	InvalidClientToken.ValueNotSupported	The ClientToken provided is invalid.	指定的 ClientToken 不合法。
400	InvalidParameter.CidrMalformed	%s	指定的CIDR地址塊不合法。
400	InvalidParameter.CidrDuplicated	%s	指定的 CIDR 地址塊重複。
400	LimitExceed.Entry	The number of entries added or removed exceeds the limit.	單次增加或刪除的條目數量超出限制。
400	LimitExceed.MaxEntries	The number of entries exceeds the MaxEntries of the specified prefix list.	條目數量超出指定首碼列表支援的最大條目數。
404	LimitExceed.PrefixListPerRegion	The number of prefix lists in the region exceeds the limit.	在當前地區下的首碼列表數量超出限制。
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	指定的地區 ID 不存在。
404	InvalidResourceGroup.NotFound	The specified resource group is not found.	找不到對應的資源群組

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

變更歷史

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