調用ModifyVpnGatewayAttribute接口修改VPN網關的名稱和描述信息。
接口說明
- ModifyVpnGatewayAttribute 接口屬于異步接口，即系統先返回 VPN 網關的信息，但該 VPN 網關的配置尚未修改成功，系統后臺的修改任務仍在進行。您可以調用 DescribeVpnGateway 查詢 VPN 網關的配置的修改狀態：
- 當 VPN 網關處于 updating 狀態時，表示 VPN 網關的配置正在修改中。
- 當 VPN 網關處于 active 狀態時，表示 VPN 網關的配置修改成功。
- ModifyVpnGatewayAttribute 接口不支持并發修改同一個 VPN 網關的配置。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:ModifyVpnGatewayAttribute | update | *VpnGateway acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | VPN 網關實例所在的地域 ID。您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-4266**** |
| VpnGatewayId | string | 是 | VPN 網關實例的 ID。 | vpn-bp1q8bgx4xnkm2ogj**** |
| Name | string | 否 | VPN 網關的新名稱。 長度為 2～100 個字符，不能以 | myvpn |
| Description | string | 否 | VPN 網關新的描述信息。 描述信息長度為 1～100 個字符。 | test |
| AutoPropagate | boolean | 否 | 是否將 BGP 路由自動傳播到 VPC。取值：
| true |
返回參數
示例
正常返回示例
JSON格式
{
"VpcId": "vpc-bp1ub1yt9cvakoel****",
"Status": "active",
"InternetIp": "116.62.XX.XX",
"Spec": "5M",
"CreateTime": 1492753580000,
"AutoPropagate": true,
"VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
"IntranetIp": "172.27.30.24",
"EndTime": 1495382400000,
"VSwitchId": "vsw-bp1y9ovl1cu9ou4tv****",
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B457",
"Description": "test",
"EnableBgp": true,
"BusinessStatus": "Normal",
"Name": "test",
"DisasterRecoveryInternetIp": "116.11.XX.XX",
"DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
"SslVpnInternetIp": "116.33.XX.XX",
"ResourceGroupId": "rg-acfmzs372yg****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidName | The name is not valid | 該名稱格式不合法。 |
| 400 | InvalidDescription | The description is not valid | 描述格式不合法。 |
| 400 | OperationUnsupported.EnableBgp | Current version of the VPN does not support enable BGP. | 當前版本的VPN不支持開啟BGP |
| 400 | OperationFailed.VpnConnectionExist | Auto propagate cannot be closed when VPN connections with BGP enabled exist. | 當存在已開啟BGP的VPN連接時，路由自動傳播無法關閉。 |
| 400 | InvalidVpnGatewayInstanceId.NotFound | The specified vpn gateway instance id does not exist. | 指定的 VPN 網關不存在，請您檢查 VPN 網關是否正確。 |
| 400 | VpnGateway.Configuring | The specified service is configuring. | 服務正在配置中，請您稍后再試。 |
| 400 | OperationFailed.CenLevelNotSupport | When the VPC to which the VPN gateway belongs is attached to a FULL-mode CEN, the VPN gateway cannot enable BGP. | 當VPN網關所屬VPC加入到的云企業網且開啟了路由同步時，VPN網關不能開啟BGP。 |
| 403 | Forbidden.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. | 您沒有權限操作指定資源，請申請權限后再操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-10-19 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 標記、OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-06-30 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |