ModifyVpcPrefixList - Virtual Private Cloud - Alibaba Cloud ドキュメントセンター

プレフィックスリストの構成を変更します。

操作説明

ModifyVpcPrefixList は非同期操作です。リクエスト送信後、システムはリクエスト ID を返しますが、変更ノードがバックグラウンドで実行中のため、プレフィックスリストインスタンスの構成はすぐには変更されません。 ListPrefixLists を呼び出して、プレフィックスリストインスタンスのステータスをクエリできます。
- プレフィックスリストインスタンスが Modifying 状態の場合、プレフィックスリストインスタンスの構成は変更中です。
- プレフィックスリストインスタンスが Created 状態の場合、プレフィックスリストインスタンスの構成は変更済みです。
- プレフィックスリストインスタンスの構成変更後、 GetVpcPrefixListAssociations を呼び出してプレフィックスリストの関連付けをクエリし、関連付けられたリソースが変更後の Classless Inter-Domain Routing (CIDR) ブロックを使用しているかどうかを確認できます。プレフィックスリストの関連付けの Status パラメーターが Created の場合、関連付けられたリソースは変更後の CIDR ブロックを使用しています。
ModifyVpcPrefixList は、同じプレフィックスリストに対する同時変更をサポートしていません。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vpc:ModifyVpcPrefixList

update

*PrefixList

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PrefixListId	string	必須	変更するプレフィックスリストのインスタンス ID。	pl-0b7hwu67****
PrefixListName	string	任意	プレフィックスリストの新しい名前。名前は 1～128 文字で、`http://` または `https://` で始まることはできません。	newname
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。RequestId は API リクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値: true: ドライランを実行します。システムは必須パラメーター、リクエスト構文、およびビジネス制限をチェックします。チェックに失敗した場合、対応するエラーが返されます。チェックに成功した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト): ドライランを実行し、リクエストを送信します。リクエストがドライランを通過した後、プレフィックスリストの構成が変更済みとなり、HTTP 2xx 状態コードが返されます。	false
AddPrefixListEntry	array<object>	任意	プレフィックスリストインスタンスに追加する Classless Inter-Domain Routing (CIDR) ブロックのリスト。
	object	任意	プレフィックスリストインスタンスに追加する Classless Inter-Domain Routing (CIDR) ブロック。
Cidr	string	任意	プレフィックスリストインスタンスに追加する Classless Inter-Domain Routing (CIDR) ブロック。説明 CIDR ブロックがすでにプレフィックスリストに存在する場合、AddPrefixListEntry.N.Description の値のみが変更済みとなります。つまり、CIDR ブロックの説明のみが変更済みとなります。	172.16.0.0/12
Description	string	任意	プレフィックスリストインスタンスに追加する Classless Inter-Domain Routing (CIDR) ブロックの説明。説明は 1～128 文字で、`http://` または `https://` で始まることはできません。	newcidr
RemovePrefixListEntry	array<object>	任意	プレフィックスリストインスタンスから削除する Classless Inter-Domain Routing (CIDR) ブロックのリスト。
	object	任意	プレフィックスリストインスタンスから削除する Classless Inter-Domain Routing (CIDR) ブロックのリスト。
Cidr	string	任意	プレフィックスリストインスタンスから削除する Classless Inter-Domain Routing (CIDR) ブロック。	192.168.0.0/16
Description	string	任意	プレフィックスリストから削除する Classless Inter-Domain Routing (CIDR) ブロックの説明。	cidr
RegionId	string	必須	変更するプレフィックスリストのリージョン ID。	cn-hangzhou
PrefixListDescription	string	任意	プレフィックスリストの新しい説明。説明は 1～256 文字で、`http://` または `https://` で始まることはできません。	newdescription
MaxEntries	integer	任意	プレフィックスリストインスタンス内の Classless Inter-Domain Routing (CIDR) ブロックエントリの新しい最大値。	20

レスポンスフィールド

フィールド	型	説明	例
	object
PrefixListId	string	プレフィックスリストのインスタンス ID。	pl-0b7hwu67****
RequestId	string	リクエスト ID。	54B48E3D-DF70-471B-AA93-08E683A1B45

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	ResourceNotFound.PrefixList	The specified resource of prefixList is not found.	指定されたプレフィックスリストが存在しません。
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 ブロックの数がプレフィックスリストが所有する数を超えています。
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.	共有プレフィックスリストに対して操作を実行することはできません。
400	IncorrectStatus.PrefixList	The status of prefixList is incorrect.	プレフィックスリストは過渡的な状態にあるため、操作できません。
400	QuotaExceeded.PrefixListCidrCount	The quota of prefixList entry maxEntry count is exceeded.	プレフィックスリストで許可されるルートエントリの最大値が制限を超えています。
400	QuotaExceeded	Route entry quota exceeded in associated route table.	現在のユーザーが作成した VPC ピアリング接続ルートインターフェイスの数が上限に達しました。
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.	一時的なサーバー障害が発生したため、リクエストに失敗しました。

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。