調用ModifyVpcPrefixList介面修改首碼列表的配置資訊。
介面說明
-
ModifyVpcPrefixList 介面屬於非同步介面,即系統返回一個請求 ID,但該首碼列表執行個體的配置資訊尚未修改成功,系統背景修改任務仍在進行。您可以調用 ListPrefixLists 查詢首碼列表執行個體的狀態。
當首碼列表執行個體處於 Modifying 狀態時,表示首碼列表執行個體的配置資訊正在修改中。
當首碼列表執行個體處於 Created 狀態時,表示首碼列表執行個體的配置資訊修改成功。
首碼列表執行個體的配置資訊修改成功後,您可以調用 GetVpcPrefixListAssociations 介面查詢首碼列表的關聯關係來確定關聯的資源是否使用的是修改後的 CIDR 地址塊,當首碼列表的關聯狀態即 Status 參數取值為 Created 時,表示關聯的資源使用的 CIDR 地址塊為修改後的 CIDR 地址塊。
-
ModifyVpcPrefixList 介面不支援並發修改同一個首碼列表執行個體的配置資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| PrefixListId |
string |
是 |
要修改的首碼列表的執行個體 ID。 |
pl-0b7hwu67**** |
| PrefixListName |
string |
否 |
修改後的首碼列表的名稱。 名稱長度為 1~128 個字元,不能以 |
newname |
| ClientToken |
string |
否 |
用戶端 Token,用於保證請求的等冪性。 從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。 |
123e4567-e89b-12d3-a456-426655440000 |
| DryRun |
boolean |
否 |
是否只預檢此次請求。取值:
|
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 個字元,不能以 |
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 個字元,不能以 |
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. | prefixList最大路由條目數超過關聯的路由表允許的最大路由條目 |
| 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. | 請求失敗,因為臨時伺服器故障。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。