ModifyVpcPrefixList - Virtual Private Cloud

呼叫 ModifyVpcPrefixList 介面修改前綴清單的設定資訊。

介面說明

ModifyVpcPrefixList 介面屬於非同步介面，即系統返回一個請求 ID，但該前綴清單執行個體的設定資訊尚未修改成功，系統背景的修改任務仍在進行。您可以呼叫 ListPrefixLists 查詢前綴清單執行個體的狀態。
- 當前綴清單執行個體處於 Modifying 狀態時，表示前綴清單執行個體的設定資訊正在修改中。
- 當前綴清單執行個體處於 Created 狀態時，表示前綴清單執行個體的設定資訊修改成功。
- 前綴清單執行個體的設定資訊修改成功後，您可以呼叫 GetVpcPrefixListAssociations 介面查詢前綴清單的關聯關係來確定關聯的資源是否使用的是修改後的 CIDR 位址區塊，當前綴清單的關聯狀態即 Status 參數取值為 Created 時，表示關聯的資源使用的 CIDR 位址區塊為修改後的 CIDR 位址區塊。
ModifyVpcPrefixList 介面不支援並行修改同一個前綴清單執行個體的設定資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:ModifyVpcPrefixList

update

*PrefixList

acs:vpc:{#regionId}:{#accountId}:prefixlist/{#PrefixListId}

無

請求參數

名稱	類型	必填	描述	樣本值
PrefixListId	string	是	要修改的前綴清單的執行個體 ID。	pl-0b7hwu67****
PrefixListName	string	否	修改後的前綴清單的名稱。名稱長度為 1～128 個字元，不能以 `http://` 或 `https://` 開頭。	newname
ClientToken	string	否	用戶端 Token，用於保證請求的冪等性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 識別碼。每次 API 請求的 RequestId 可能不一樣。	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	否	是否只預檢此次請求。取值： true：傳送檢查請求，不會修改前綴清單的設定資訊。檢查項目包括是否填寫了必要參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼 `DryRunOperation`。 false（預設值）：傳送正常請求，通過檢查後返回 HTTP 2xx 狀態碼並直接修改前綴清單的設定資訊。	false
AddPrefixListEntry	array<object>	否	要新增的前綴清單執行個體的 CIDR 位址區塊清單資訊。
	object	否	要新增的前綴清單執行個體的 CIDR 位址區塊資訊。
Cidr	string	否	要新增的前綴清單執行個體的 CIDR 位址區塊。說明如果要新增的 CIDR 位址區塊已經在前綴清單中存在，則只修改 AddPrefixListEntry.N.Description 的值，即只修改該 CIDR 位址區塊的描述資訊。	172.16.0.0/12
Description	string	否	要新增的前綴清單執行個體的 CIDR 位址區塊描述資訊。描述長度為 1～128 個字元，不能以 `http://` 或 `https://` 開頭。	newcidr
RemovePrefixListEntry	array<object>	否	要刪除的前綴清單執行個體的 CIDR 位址區塊清單資訊。
	object	否	要刪除的前綴清單執行個體的 CIDR 位址區塊清單資訊。
Cidr	string	否	要刪除的前綴清單執行個體的 CIDR 位址區塊。	192.168.0.0/16
Description	string	否	要刪除的前綴清單的 CIDR 位址區塊的描述資訊。	cidr
RegionId	string	是	要修改設定資訊的前綴清單執行個體所在的地域 ID。	cn-hangzhou
PrefixListDescription	string	否	修改後的前綴清單執行個體的描述資訊。描述長度為 1～256 個字元，不能以 `http://` 或 `https://` 開頭。	newdescription
MaxEntries	integer	否	修改後的前綴清單執行個體的最大 CIDR 位址區塊條目數。	20

返回參數

名稱	類型	描述	樣本值
	object
PrefixListId	string	前綴清單的執行個體 ID。	pl-0b7hwu67****
RequestId	string	請求 ID。	54B48E3D-DF70-471B-AA93-08E683A1B45

樣本

正常返回樣本

JSON格式

{
  "PrefixListId": "pl-0b7hwu67****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	ResourceNotFound.PrefixList	The specified resource of prefixList is not found.	輸入的 prefixList 不存在。
400	OperationFailed.CidrCountExceedMaxCount	The operation is failed because of cidrCountExceedMaxCount.	使用者傳入的 cidr 數量超過 cidrMaxCount。
400	OperationDenied.RemoveCountExceedExistCount	The operation is not allowed because of remove-count exceed exist-count.	刪除的 CIDR 數量超過 PrefixList 擁有的數量。
400	DuplicatedParam.CidrBlock	The param of cidrBlock is duplicated.	傳入了重複的 cidrBlock。
400	IllegalParam.CidrBlock	The param of cidrBlock is illegal.	CidrBlock 參數不合法。
400	IllegalParam.CidrName	The param of cidrName is illegal.	輸入的 cidrName 無效。
400	OperationDenied.SystemPrefixList	This is not allowed to operate system prefixList.
400	OperationFailed.OperateShareResource	This is not allowed to operate shared prefixList.	無法操作共享 PrefixList。
400	IncorrectStatus.PrefixList	The status of prefixList is incorrect.	PrefixList 處於中間態，無法操作。
400	QuotaExceeded.PrefixListCidrCount	The quota of prefixList entry maxEntry count is exceeded.	prefixList 允許的最大路由項目數量超過限制。
400	QuotaExceeded	Route entry quota exceeded in associated route table.	目前使用者建立的對等連線路由器介面數量已達上限。
400	OperationDenied.QuotaExceededWithNetworkAcl	If the prefix list increases MaxEntries, the quota for the maximum number of entries for the associated network ACL instance %s is exceeded.	如果前綴清單提升了最大條目數，會超過關聯的網路 ACL 執行個體的最大條目數配額。
400	ServiceUnavailable	The request has failed due to a temporary failure of the server.	請求失敗，因為臨時伺服器故障。

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

變更歷史

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