You need to enable JavaScript to run this app.
文档中心
VPN连接

VPN连接

复制全文
下载 pdf
用户网关
ModifyCustomerGatewayAttributes-修改用户网关
复制全文
下载 pdf
ModifyCustomerGatewayAttributes-修改用户网关
调用ModifyCustomerGatewayAttributes修改指定用户网关的名称、描述信息。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:ModifyCustomerGatewayAttributes​
要执行的操作,取值:ModifyCustomerGatewayAttributes。​
​
Version String 必选 示例值:2020-04-01​
API版本信息。​
​
CustomerGatewayId String 必选 示例值:cgw-3tehy13n2l4c6c0v****​
用户网关实例的ID。您可调用DescribeCustomerGateways查询用户网关的ID信息。​
​
CustomerGatewayName String 可选 示例值:CGW-q04n​
用户网关实例的名称。​
  • 以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、下划线(_)和短划线(-)。​
  • 长度限制为1 ~ 128个字符。​
  • 不填保持原有配置。​
​
Description String 可选 示例值:This is a sample description​
用户网关实例的描述。​
  • 以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、空格( )、下划线(_)、中划线(-)、等号(=)、英文逗号(,)、中文逗号(,)、中文句号(。)。​
  • 长度限制为0 ~ 255个字符。​
  • 不填保持原有配置。​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
RequestId String 可选 示例值:202203211611080102121461940900****​
请求ID。​
​
​
请求示例​
​
GET /?Action=ModifyCustomerGatewayAttributes&Version=2020-04-01&CustomerGatewayId=cgw-2d670j2o9lc0058ozfddg****&CustomerGatewayName=test&Description=test HTTP/1.1​
Host: vpn.cn-beijing.volcengineapi.com​
X-Date: 20251029T033538Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251029/cn-beijing/vpn/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202203211611080102121461940900****",​
"Action": "ModifyCustomerGatewayAttributes",​
"Version": "2020-04-01",​
"Service": "vpn",​
"Region": "cn-beijing"​
},​
"Result": {​
"RequestId": "202203211611080102121461940900****"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidName.Malformed​
The specified name is malformed.Ensure the maximum length of name is 128.​
指定的名称格式不合法。名称长度不能超过128个字符。​
400​
InvalidName.Malformed​
The specified name is malformed.​
指定的名称格式不合法。请修复名称格式后重试。​
400​
InvalidDescription.Malformed​
The specified description is malformed.Ensure the maximum length of description is 255.​
指定的描述格式不合法。描述长度不能超过255个字符。​
400​
InvalidDescription.Malformed​
The specified description is malformed.​
指定的描述格式不合法。请修复描述格式后重试。​
400​
InvalidCustomerGateway.InvalidStatus​
The specified customer gateway is not in the correct status for the request.​
指定的用户网关所处的状态无法响应该请求。​
404​
InvalidCustomerGateway.NotFound​
The specified customer gateway does not exist.​
指定的用户网关不存在。​
​
最近更新时间:2026.02.02 11:15:04
这个页面对您有帮助吗?
有用
有用
无用
无用