调用CreateCustomerGateway创建一个用户网关。
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | CreateCustomerGateway | 要执行的操作，取值：CreateCustomerGateway。 |
| Version | String | 是 | 2020-04-01 | API版本信息。 |
CustomerGatewayName | String | 否 | CGW-t26c | 用户网关的名称。
|
| IpAddress | String | 是 | 8.XX.XX.8 | 对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。 |
Description | String | 否 | This is a sample description | 用户网关的描述信息。
|
ClientToken | String | 否 | 123e4567-e89b-12d3-a456-42665544**** | 客户端Token，用于保证请求幂等性。
|
| ProjectName | String | 否 | Project_1 | 用户网关所属的项目。不填默认为default，即创建的资源属于default项目。您可调用ListProjects查询当前账号下项目的信息。 |
Asn | Integer | 否 | 65000 | 用户网关的ASN（Autonomous System Number）。
说明 VPN连接BGP功能为邀测功能，仅开通后可使用，如需试用请联系客户经理。未开通请不要传入此参数。 |
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 2022032111142501022524314704AF**** | 请求ID。 |
| CustomerGatewayId | String | cgw-3tex2x1cwd4c6c0v**** | 新创建用户网关的ID。 |
GET /?Action=CreateCustomerGateway&Version=2020-04-01&CustomerGatewayName=test&Description=test&IpAddress=1.1.1.1 HTTP/1.1 Host: open.volcengineapi.com ServiceName: vpn Region: cn-beijing
{ "ResponseMetadata":{ "RequestId":"2022032111142501022524314704AF****", "Action":"CreateCustomerGateway", "Version":"2020-04-01", "Service":"vpn", "Region":"cn-beijing" }, "Result":{ "RequestId":"2022032111142501022524314704AF****", "CustomerGatewayId":"cgw-2d670j2o9lc0058ozfddg****" } }
此处仅展示当前API的错误码，更多错误码请参见公共错误码。
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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 | InvalidCustomerGatewayIp.Malformed | The specified customer gateway ip is malformed. | 指定的用户网关IP不合法。 |
| 400 | QuotaExceeded.CustomerGateway | You've reached the limit on the number of customer gateway per region that you can create. | 已达到每个地域可创建的用户网关的数量上限。 |
| 400 | IdempotentParameterMismatch | Arguments on this idempotent request are inconsistent with arguments used in previous request(s). | 此幂等请求的参数与前一个请求中使用的参数不一致。 |
| 400 | InvalidParameter.ClientTokenMalformed | The specified parameter ClientToken is malformed. | 指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。 |
| 400 | InvalidCustomerGateway.InvalidASN | The Customer Gateway ASN is invalid and it should be in the range of 1-4294967294, excluding 65535, 137718 and 150436. | 指定的ASN不合法，应该属于1-4294967294范围内，65535，137718和150436除外。 |
| 403 | Forbidden.VpnGatewayBgpPermissionNotGranted | The specified account is not granted VPN gateway BGP permission. | 当前账号未开通VPN支持BGP权限。 |
| 404 | InvalidProject.NotFound | The specified Project does not exist. | 指定的项目不存在。 |
| 412 | IdempotentProcessing | The request uses the same client token as a previous one that is still in process. | 幂等请求处理中。 |