DeleteGateway - - Alibaba Cloud ドキュメントセンター

ゲートウェイを削除します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mse:DeleteGateway

delete

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DeleteSlb	boolean	任意	ゲートウェイを削除する際に、ゲートウェイ用に購入した SLB インスタンスを削除するかどうかを指定します。	true
GatewayUniqueId	string	必須	ゲートウェイの一意の ID。	gw-0fe488252dc44d55a9dd57875193a1d7
AcceptLanguage	string	任意	応答メッセージの言語。有効な値： zh: 中国語 en: 英語	zh

レスポンスフィールド

フィールド	型	説明	例
	object	データ構造。
RequestId	string	リクエスト ID。	2FFEA345-BE30-5FE0-8885-42E2DEFD5FE6
HttpStatusCode	integer	返される HTTP ステータスコード。	200
Message	string	返されるメッセージ。リクエストが成功した場合、成功メッセージが返されます。リクエストが失敗した場合、「TaskId not found」などのエラーメッセージが返されます。	The request is successfully processed.
Code	integer	返される HTTP ステータスコード。値 200 はリクエストが成功したことを示します。その他の値はリクエストが失敗したことを示します。	200
Success	boolean	リクエストが成功したかどうかを示します。有効な値： `true`：リクエストは成功しました。 `false`：リクエストは失敗しました。	true
Data	object	データの詳細。
Id	integer	プライマリキーの ID。	12
Name	string	ゲートウェイの名前。	mse-bc1a29b0-reg-center-0-1
GatewayUniqueId	string	ゲートウェイの一意の ID。この ID はシステムによって自動的に生成されます。	gw-7ea3da97b96543e19f6c597c****
Region	string	リージョン ID。	cn-hangzhou
PrimaryUser	string	ユーザーに関する情報。	1231254
Status	integer	ゲートウェイのステータス。有効な値：0: ゲートウェイは作成中です。1: ゲートウェイの作成に失敗しました。2: ゲートウェイは実行中です。3: ゲートウェイは変更中です。4: ゲートウェイはスケールダウン中です。6: ゲートウェイはスケールアップ中です。8: ゲートウェイは削除中です。10: ゲートウェイは再起動中です。11: ゲートウェイは再構築中です。12: ゲートウェイは更新中です。13: ゲートウェイの更新に失敗しました。	1
Vpc	string	ゲートウェイが存在する Virtual Private Cloud (VPC) の ID。	vpc-bp1328cm01m6uel42b5zb
Vswitch	string	vSwitch の ID。	vsw-bp18zeqxx6mpuq843z4n5
SecurityGroup	string	セキュリティグループの ID。	sg-bp11ufzqn6mmb8dtzz82
Spec	string	ゲートウェイの仕様。	MSE_GTW_16_32_200_c
Replica	integer	ゲートウェイレプリカの数。	2
GmtCreate	string	作成時刻。	2022-01-07T10:07:57.000+0000
GmtModified	string	ゲートウェイの最終更新時刻。	2022-01-07T10:07:57.000+0000

例

成功レスポンス

JSONJSON

{
  "RequestId": "2FFEA345-BE30-5FE0-8885-42E2DEFD5FE6",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "Code": 200,
  "Success": true,
  "Data": {
    "Id": 12,
    "Name": "mse-bc1a29b0-reg-center-0-1",
    "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597c****",
    "Region": "cn-hangzhou",
    "PrimaryUser": "1231254",
    "Status": 1,
    "Vpc": "vpc-bp1328cm01m6uel42b5zb",
    "Vswitch": "vsw-bp18zeqxx6mpuq843z4n5",
    "SecurityGroup": "sg-bp11ufzqn6mmb8dtzz82",
    "Spec": "MSE_GTW_16_32_200_c",
    "Replica": 2,
    "GmtCreate": "2022-01-07T10:07:57.000+0000",
    "GmtModified": "2022-01-07T10:07:57.000+0000"
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IllegalRequest	Invalid request:%s
400	InvalidParameter	Parameter error:%s
500	InternalError	Console error. Try again later:%s
403	NoPermission	You are not authorized to perform this operation:%s
404	NotFound	Not found:%s

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

変更履歴

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