ModifyVpnGatewayAttribute - VPN Gateway - Alibaba Cloud ドキュメントセンター

VPN ゲートウェイの名前、説明、または自動ルート伝播の特徴を変更します。

操作説明

ModifyVpnGatewayAttribute 操作は非同期です。システムは、構成が変更される前の VPN ゲートウェイの情報を返します。変更タスクは引き続きバックグラウンドで実行中です。 DescribeVpnGateway 操作を呼び出し、VPN ゲートウェイの構成の変更ステータスをクエリできます。
- VPN ゲートウェイが updating 状態の場合、構成が変更中です。
- VPN ゲートウェイが アクティブな 状態の場合、構成は変更済みです。
ModifyVpnGatewayAttribute 操作は、同じ VPN ゲートウェイの構成に対する同時変更をサポートしていません。

今すぐお試しください

この 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:ModifyVpnGatewayAttribute

update

*VpnGateway。

acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	VPN ゲートウェイのリージョン ID。 DescribeRegions 操作を呼び出し、リージョン ID をクエリできます。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントでパラメーター値を生成して、異なるリクエスト間で値が一意になるようにできます。クライアントトークンは ASCII 文字のみをサポートします。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId をクライアントトークンとして自動的に使用します。各 API リクエストの RequestId は異なります。	123e4567-e89b-12d3-a456-4266****
VpnGatewayId	string	必須	VPN ゲートウェイの ID。	vpn-bp1q8bgx4xnkm2ogj****
Name	string	任意	VPN ゲートウェイの新しい名前。名前は 2～100 文字の長さである必要があります。http:// または https:// で始めることはできません。先頭は英字である必要があり、英字、数字、アンダースコア (_)、ハイフン (-)、ピリオド (.) を含めることができます。その他の特殊文字はサポートされていません。	myvpn
Description	string	任意	VPN ゲートウェイの新しい説明。説明は 1～100 文字の長さである必要があります。	test
AutoPropagate	boolean	任意	VPN ゲートウェイの自動ルート伝播の特徴を有効にするかどうかを指定します。有効な値: true: 特徴を有効にします。自動ルート伝播を有効にすると、VPN ゲートウェイインスタンスは VPC のシステムルートテーブル内のシステムルートを自動的に学習し、オンプレミスデータセンターのルートを VPC のシステムルートテーブルに自動的に伝播します。 false: 特徴を無効にします。自動ルート伝播を無効にする前に、VPN ゲートウェイ配下のすべての IPsec-VPN 接続で BGP 動的ルートの特徴が無効になっていることを確認してください。	true

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
VpcId	string	VPN ゲートウェイが属する VPC の ID。	vpc-bp1ub1yt9cvakoel****
Status	string	VPN ゲートウェイのステータス。有効な値: init: 初期化中 provisioning: 準備中 active: アクティブな updating: 更新中 deleting: 削除中	active
InternetIp	string	VPN ゲートウェイがシングルトンネル IPsec-VPN 接続をサポートしている場合、このパラメーターは VPN ゲートウェイの IP アドレスを示し、IPsec-VPN 接続または SSL-VPN 接続の作成に使用できます。 VPN ゲートウェイがデュアルトンネル IPsec-VPN 接続をサポートしている場合、このパラメーターは IPsec-VPN 接続の作成に使用される最初の IP アドレスを示します。SSL-VPN 接続の作成には使用できません。 VPN ゲートウェイがデュアルトンネル IPsec-VPN 接続をサポートしている場合、システムはデュアルトンネル IPsec-VPN 接続を作成するために 2 つの IPsec アドレスを VPN ゲートウェイに割り当てます。	116.62.XX.XX
Spec	string	VPN ゲートウェイの帯域幅スペック。単位: Mbit/s。	5M
CreateTime	integer	VPN ゲートウェイが作成されたタイムスタンプ。単位: ミリ秒。タイムスタンプは UNIX 時間フォーマットに従います。エポック時間である 1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) からの経過ミリ秒数を示します。	1492753580000
AutoPropagate	boolean	BGP ルートが VPC に自動的に伝播されるかどうかを示します。有効な値: true: 自動的に伝播される false: 自動的に伝播されない	true
VpnGatewayId	string	VPN ゲートウェイの ID。	vpn-bp1q8bgx4xnkm2ogj****
IntranetIp	string	システムが VPN ゲートウェイをデプロイするときに占有される vSwitch の非公開 IP アドレス。このパラメーターは、シングルトンネル IPsec-VPN 接続のみをサポートし、IPsec-VPN の特徴が有効になっている VPN ゲートウェイに対してのみ返されます。	172.16.10.46
EndTime	integer	VPN ゲートウェイインスタンスの有効期限切れ時の UNIX タイムスタンプ。単位: ミリ秒。 UNIX タイムスタンプは UNIX 時間フォーマットに従います。エポック時間である 1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) から VPN ゲートウェイインスタンスの有効期限切れまでの経過ミリ秒数を示します。	1495382400000
VSwitchId	string	VPN ゲートウェイに関連付けられている vSwitch の ID。	vsw-bp1y9ovl1cu9ou4tv****
RequestId	string	リクエスト ID。	54B48E3D-DF70-471B-AA93-08E683A1B457
Description	string	VPN ゲートウェイの説明。	test
EnableBgp	boolean	VPN ゲートウェイで BGP の特徴が有効になっているかどうかを示します。有効な値: true: 有効 false: 無効	true
BusinessStatus	string	VPN ゲートウェイインスタンスの課金ステータス。有効な値: Normal: 法線 FinancialLocked: 料金滞納についてロック済み	Normal
Name	string	VPN ゲートウェイの名前。	test
DisasterRecoveryInternetIp	string	IPsec-VPN 接続を作成するためにシステムによって VPN ゲートウェイに割り当てられた 2 番目の IP アドレス。このパラメーターは、デュアルトンネル IPsec-VPN 接続をサポートする VPN ゲートウェイに対してのみ返されます。	116.11.XX.XX
DisasterRecoveryVSwitchId	string	VPN ゲートウェイに関連付けられている 2 番目の vSwitch の ID。このパラメーターは、デュアルトンネル IPsec-VPN 接続をサポートする VPN ゲートウェイに対してのみ返されます。	vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIp	string	SSL-VPN 接続の IP アドレス。このパラメーターは、デュアルトンネル IPsec-VPN 接続をサポートするパブリックネットワークタイプの VPN ゲートウェイインスタンスで SSL-VPN の特徴が有効になった後にのみ返されます。	116.33.XX.XX
ResourceGroupId	string	VPN ゲートウェイが属するリソースグループの ID。 ListResourceGroups 操作を呼び出し、リソースグループ情報をクエリできます。	rg-acfmzs372yg****

例

成功レスポンス

JSONJSON

{
  "VpcId": "vpc-bp1ub1yt9cvakoel****",
  "Status": "active",
  "InternetIp": "116.62.XX.XX",
  "Spec": "5M",
  "CreateTime": 1492753580000,
  "AutoPropagate": true,
  "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
  "IntranetIp": "172.16.10.46",
  "EndTime": 1495382400000,
  "VSwitchId": "vsw-bp1y9ovl1cu9ou4tv****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B457",
  "Description": "test",
  "EnableBgp": true,
  "BusinessStatus": "Normal",
  "Name": "test",
  "DisasterRecoveryInternetIp": "116.11.XX.XX",
  "DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
  "SslVpnInternetIp": "116.33.XX.XX",
  "ResourceGroupId": "rg-acfmzs372yg****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidName	The name is not valid
400	InvalidDescription	The description is not valid
400	OperationUnsupported.EnableBgp	Current version of the VPN does not support enable BGP.	現在のバージョンの VPN ゲートウェイは BGP をサポートしていません。
400	OperationFailed.VpnConnectionExist	Auto propagate cannot be closed when VPN connections with BGP enabled exist.	BGP が有効な VPN 接続が存在する場合、自動ルート伝播を無効にすることはできません。
400	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.	指定された VPN ゲートウェイが存在しません。VPN ゲートウェイが正しいかどうかを確認してください。
400	VpnGateway.Configuring	The specified service is configuring.
400	OperationFailed.CenLevelNotSupport	When the VPC to which the VPN gateway belongs is attached to a FULL-mode CEN, the VPN gateway cannot enable BGP.	VPN ゲートウェイが属する VPC がルート同期の有効化された CEN インスタンスにアタッチされている場合、VPN ゲートウェイで BGP を有効にできません。
400	OperationFailed.VpcRoutePropagationDisable	The VPC system routing table does not enable the acceptance of propagated routes.	VPC システムルートテーブルでルート伝播の受け入れが有効になっていません。
400	OperationFailed.VpcRoutePublishEnabledInTR	A VPC supports at most one dynamic route learning source. In the forwarding router, disable route synchronization for the VPC.	VPC は動的ルート学習ソースを 1 つだけサポートしています。トランジットルーターで VPC のルート同期を無効にしてください。
400	OperationFailed.VpcRoutePublishEnabledInECR	VPC supports only one dynamic route learning source at most. Please remove the VPC from ECR.	VPC は動的ルート学習ソースを 1 つだけサポートしています。Express Connect Router (ECR) から VPC を削除してください。
400	OperationFailed.BondingVpnNotSupportBGP	The architecture does not support BGP capabilities (single tunnel bonding architecture VPN gateway).	このアーキテクチャは BGP 機能をサポートしていません (シングルトンネルボンディングアーキテクチャの VPN ゲートウェイ)。
400	OperationFailed.StaleBGPRoutes	BGP routes are still there and automatic route propagation cannot be disabled.	残留 BGP ルートが存在します。自動ルート伝播を停止できません。
403	Forbidden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	このリソースに対する操作権限がありません。必須の権限を申請して、もう一度お試しください。
403	Forbidden	User not authorized to operate on the specified resource.	指定されたリソースに対して操作を実行する権限がありません。必須の権限を申請してから、再度お試しください。
404	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.

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

変更履歴

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