ModifyCustomerGatewayAttribute
修改用户网关的配置
服务地址：
华东1（杭州）
输入参数
只看必填
RegionId用户网关所属的地域ID
CustomerGatewayId用户网关的实例ID
Name用户网关的名称
Description用户网关的描述信息
AuthKey本地数据中心网关设备BGP路由协议的认证密钥
幂等性参数
ClientToken客户端Token
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

  • 调用 ModifyCustomerGatewayAttribute 接口时，如果参数 AuthKey 不为空时，该接口为异步接口，即系统先返回用户网关的信息，但该用户网关的配置尚未修改成功，系统后台的修改任务仍在进行。您可以调用 DescribeVpnGateway 查询用户网关的配置的修改状态：

    • 当 VPN 网关实例处于 updating 状态时，表示用户网关的配置正在修改中。
    • 当 VPN 网关实例处于 active 状态时，表示用户网关的配置修改成功。

  • 调用 ModifyCustomerGatewayAttribute 接口时，如果参数 AuthKey 为空时，该接口为同步接口。

  • ModifyCustomerGatewayAttribute 接口不支持并发修改同一个用户网关的配置。

请求参数

字段名称字段详情
RegionIdstring

用户网关所属的地域 ID。 展开详情

示例值:cn-shanghai参考取值来源:
    DescribeRegions
ClientTokenstring

客户端 Token，用于保证请求的幂等性。展开详情

示例值:02fb3da4-130e-11e9-8e44****
CustomerGatewayIdstring

用户网关的实例 ID。

示例值:cgw-bp1pvpl9r9adju6l5****参考取值来源:
    CreateCustomerGateway
    DescribeCustomerGateways
Namestring

用户网关的名称。 展开详情

示例值:nametest
Descriptionstring

用户网关的描述信息。 展开详情

示例值:desctest
AuthKeystring

本地数据中心网关设备 BGP 路由协议的认证密钥。展开详情

示例值:AuthKey****

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:8AA5CE21-2E6A-4530-BDF5-F055849476E6
IpAddressstring

本地数据中心网关设备的公网 IP 地址。

示例值:139.32.XX.XX
Descriptionstring

用户网关的描述信息。

示例值:desctest
CustomerGatewayIdstring

用户网关的实例 ID。

示例值:cgw-bp1pvpl9r9adju6l5****
CreateTimeinteger<int64>

创建用户网关的时间戳。

注意 请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。
示例值:1492747187000
Namestring

用户网关的名称。

示例值:nametest
ResourceGroupIdstring

用户网关所属的资源组 ID。展开详情

示例值:rg-acfmzs372yg****
变更历史
暂无变更历史