全部產品
Search
文件中心

VPN Gateway:DeleteIpsecServer - 刪除IPsec服務端

更新時間:Apr 27, 2026

調用DeleteIpsecServer介面刪除IPsec服務端。

介面說明

  • DeleteIpsecServer 介面屬於非同步介面,即系統先返回一個請求 ID,但該 IPsec 服務端尚未刪除成功,系統背景刪除任務仍在進行。您可以調用 DescribeVpnGateway 查詢 VPN 閘道執行個體狀態,來確定 IPsec 服務端的刪除狀態:
    • 當 VPN 閘道執行個體處於 updating 狀態時,表示 IPsec 服務端正在刪除中。

    • 當 VPN 閘道執行個體處於 active 狀態時,表示 IPsec 服務端刪除成功。

  • DeleteIpsecServer 介面不支援在同一 VPN 閘道下並發刪除 IPsec 服務端。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

IPsec 服務端所屬地區 ID。

cn-hangzhou

IpsecServerId

string

IPsec 服務端 ID。

iss-bp1jougp8cfsbo8y9****

ClientToken

string

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

從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。

說明

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

02fb3da4-130e-11e9-8e44-00****

DryRun

string

是否只預檢此次請求,取值:

  • true:只預檢此次請求,不會刪除 IPsec 服務端。檢查項包括是否填寫了必需參數、請求格式、業務限制等。如果檢查不通過,則返回對應錯誤資訊。如果檢查通過,則返回DryRunOperation

  • false(預設值):發送正常請求,通過檢查後直接刪除 IPsec 服務端。

false

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

0ED8D006-F706-4D23-88ED-E11ED28DCAC0

樣本

正常返回樣本

JSON格式

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 VpnGateway.Configuring The specified service is configuring.
403 Forbidden User not authorized to operate on the specified resource. 您沒有許可權操作指定資源,請申請許可權後再操作。
404 InvalidIpsecServerId.NotFound The specified IPsec server ID (%s) does not exist.
409 OperationConflict The operation against this instance is too frequent, please try again later. 對該執行個體的操作過於頻繁,請稍後重試。

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

變更歷史

更多資訊,參考變更詳情