修改VPN网关属性

最近更新时间:2024-07-24 02:27:54

我的收藏

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(ModifyVpnGatewayAttribute)用于修改VPN网关属性。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyVpnGatewayAttribute。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
VpnGatewayId String VPN网关实例ID。
示例值:vpngw-edvft32x
VpnGatewayName String VPN网关名称,最大长度不能超过60个字节。
示例值:test-vpn
InstanceChargeType String VPN网关计费模式,目前只支持预付费(即包年包月)到后付费(即按量计费)的转换。即参数只支持:POSTPAID_BY_HOUR。
示例值:POSTPAID_BY_HOUR
BgpAsn Integer BGP ASN。ASN取值范围为1- 4294967295,默认值64551,其中139341、45090和58835不可用。
示例值:0
MaxConnection Integer 服务端最大连接数个数。
示例值:10

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改VPN网关属性

修改VPN网关属性

输入示例

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyVpnGatewayAttribute
<公共请求参数>

{
    "VpnGatewayId": "vpngw-edvft32x",
    "VpnGatewayName": "test-vpn",
    "InstanceChargeType": "POSTPAID_BY_HOUR"
}

输出示例

{
    "Response": {
        "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidParameterValue.Malformed 入参格式不合法。
InvalidParameterValue.TooLong 无效参数值。参数值太长。
ResourceNotFound 资源不存在。
UnsupportedOperation.InvalidState 资源状态不合法。
UnsupportedOperation.VpnUnsupportedModifyBgpAsn VPN不支持修改BGP ASN。