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

操作説明

カスタマーゲートウェイを削除する前に、カスタマーゲートウェイが IPsec 接続に関連付けられていないことを確認してください。IPsec 接続を削除するには、 DeleteVpnAttachment または DeleteVpnConnection を参照してください。

今すぐお試しください

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

delete

*CustomerGateway

acs:vpc:{#regionId}:{#accountId}:customergateway/{#CustomerGatewayId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	カスタマーゲートウェイのリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID を取得できます。	cn-shanghai
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントがこのパラメーター値を生成します。この値は異なるリクエスト間で一意である必要があります。最大値は 64 ASCII 文字です。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として使用します。RequestId は API リクエストごとに異なる場合があります。	02fb3da4-130e-11e9-8e44-0016e04****
CustomerGatewayId	string	必須	カスタマーゲートウェイインスタンスの ID。	cgw-bp1pvpl9r9adju6l5****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	606998F0-B94D-48FE-8316-ACA81BB230DA

例

成功レスポンス

JSONJSON

{
  "RequestId": "606998F0-B94D-48FE-8316-ACA81BB230DA"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	DependencyViolation.VpnConnection	There are vpn connections on specified customer gateway not deleted.
400	VpnGateway.task.conflict	The VPN is in the configuration state, please wait a while before operating.
403	Forbbiden.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	InvalidCustomerGatewayInstanceId.NotFound	The specified customer gateway instance id does not exist.

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

変更履歴

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