You need to enable JavaScript to run this app.
导航
VPN连接
  • 文档首页
    • /
  • VPN连接

ModifyCustomerGatewayAttributes

最近更新时间：2023.09.05 08:20:02

首次发布时间：2022.04.28 07:17:15

我的收藏

调用ModifyCustomerGatewayAttributes修改指定用户网关的名称、描述信息。

请求参数

名称类型是否必选示例值描述
ActionString是ModifyCustomerGatewayAttributes要执行的操作，取值：ModifyCustomerGatewayAttributes。
VersionString是2020-04-01API版本信息。
CustomerGatewayIdString是cgw-3tehy13n2l4c6c0v****用户网关实例的ID。您可调用DescribeCustomerGateways查询用户网关的ID信息。

CustomerGatewayName

String

否

CGW-q04n

用户网关实例的名称。

  • 以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。
  • 长度限制为1 ~ 128个字符。
  • 不填保持原有配置。

Description

String

否

This is a sample description

用户网关实例的描述。

  • 以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。
  • 长度限制为0 ~ 255个字符。
  • 不填保持原有配置。

返回数据

名称类型
示例值
描述
RequestIdString202203211611080102121461940900****请求ID。

请求示例

GET /?Action=ModifyCustomerGatewayAttributes&Version=2020-04-01&CustomerGatewayId=cgw-2d670j2o9lc0058ozfddg****&CustomerGatewayName=test&Description=test HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202203211611080102121461940900****",
        "Action": "ModifyCustomerGatewayAttributes",
        "Version": "2020-04-01",
        "Service": "vpn",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "202203211611080102121461940900****"
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode错误码错误信息描述
400InvalidName.MalformedThe specified name is malformed.Ensure the maximum length of name is 128.指定的名称格式不合法。名称长度不能超过128个字符。
400InvalidName.MalformedThe specified name is malformed.指定的名称格式不合法。请修复名称格式后重试。
400InvalidDescription.MalformedThe specified description is malformed.Ensure the maximum length of description is 255.指定的描述格式不合法。描述长度不能超过255个字符。
400InvalidDescription.MalformedThe specified description is malformed.指定的描述格式不合法。请修复描述格式后重试。
400InvalidCustomerGateway.InvalidStatusThe specified customer gateway is not in the correct status for the request.指定的用户网关所处的状态无法响应该请求。
404InvalidCustomerGateway.NotFoundThe specified customer gateway does not exist.指定的用户网关不存在。