調用DeleteCustomerGateway接口刪除指定的用戶網關。
接口說明
刪除用戶網關前，請確保用戶網關未關聯任何 IPsec 連接。刪除 IPsec 連接，請參見 DeleteVpnAttachment 或 DeleteVpnConnection 。
調試
您可以在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**** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "606998F0-B94D-48FE-8316-ACA81BB230DA"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | DependencyViolation.VpnConnection | There are vpn connections on specified customer gateway not deleted. | 指定的用戶網關上有 vpn 連接未刪除。 |
| 400 | VpnGateway.task.conflict | The VPN is in the configuration state, please wait a while before operating. | 該VPN處于正在配置狀態，請稍等一會再進行操作。 |
| 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. | 指定的用戶網關實例不存在，請您檢查用戶網關實例ID是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-01-04 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 標記、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |