全部產品
Search
文件中心

VPN Gateway:DeleteCustomerGateway

更新時間:Jun 19, 2026

呼叫 DeleteCustomerGateway 介面刪除指定的使用者閘道。

介面說明

刪除使用者閘道前,請確保使用者閘道未關聯任何 IPsec 連線。刪除 IPsec 連線,請參見 DeleteVpnAttachmentDeleteVpnConnection

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:DeleteCustomerGateway

delete

*CustomerGateway

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

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

使用者閘道所在的地域 ID。您可以透過呼叫 DescribeRegions 介面取得地域 ID。

cn-shanghai

ClientToken

string

用戶端 Token,用於保證請求的冪等性。

由用戶端產生該參數值,要保證在不同請求間唯一,最大值不超過 64 個 ASCII 字元。

說明

若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。

02fb3da4-130e-11e9-8e44-0016e04****

CustomerGatewayId

string

使用者閘道的執行個體 ID。

cgw-bp1pvpl9r9adju6l5****

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

606998F0-B94D-48FE-8316-ACA81BB230DA

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情