CreateCustomerGateway_专有网络_API文档

2016-04-28

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

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

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

vpc:CreateCustomerGateway	Create	CustomerGateway acs:vpc:{#regionId}:{#accountId}:customergateway/*	无	无

请求参数

字段名称	字段详情
RegionIdstring	用户网关所在的地域 ID。展开详情示例值:cn-shanghai参考取值来源: DescribeRegions
ClientTokenstring	客户端 Token，用于保证请求的幂等性。展开详情示例值:02fb3da4-130e-11e9-8e44****
IpAddressstring	输入本地数据中心网关设备的静态 IP 地址。展开详情示例值:101.12.XX.XX参考取值来源: DescribePublicIpAddress ListPublicIpAddressPools CreatePublicIpAddressPool
Namestring	用户网关的名称。展开详情示例值:nametest
Descriptionstring	用户网关的描述信息。展开详情示例值:desctest
Asnstring	如果 IPsec-VPN 连接计划启用 BGP 动态路由协议，则需要配置本地数据中心网关设备的自治系统号 ASN（Autonomous System Number）。自治系统号取值范围：1~4294967295，不支持使用 45104。展开详情示例值:65530
AuthKeystring	本地数据中心网关设备 BGP 路由协议的认证密钥。展开详情示例值:AuthKey****
Tagsarray<object>	用户网关待添加的标签列表。展开详情子级条数 <= 21
ResourceGroupIdstring	用户网关所属的资源组 ID。展开详情示例值:rg-aek2qo2h4jy****

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:D32B3C26-6C6C-4988-93E9-D2A6444CE6AE
IpAddressstring	本地数据中心网关设备的静态 IP 地址。示例值:101.12.XX.XX
Descriptionstring	用户网关的描述信息。示例值:desctest
CustomerGatewayIdstring	用户网关的实例 ID。示例值:cgw-bp1jrawp82av6bws9****
CreateTimeinteger<int64>	创建用户网关的时间戳。单位：毫秒。展开详情注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:1493363486000
Namestring	用户网关的名称。示例值:nametest

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	InvalidAuthkey.Malformed	The specified BGP authentication key (%s) is malformed.	诊断
400	InvalidIpAddress.AlreadyExist	Specified IpAddress is already exist.	诊断
400	InvalidIpAddress.WrongFormat	Specified IpAddress is invalid.	诊断
400	InvalidName	The name is not valid	诊断
400	InvalidDescription	The description is not valid	诊断
400	Resource.QuotaFull	The quota of resource is full	诊断
400	IllegalParam.Asn	The specified Asn is invalid.	诊断
400	OperationDenied.MissingAsn	The autonomous system number of the customer gateway is mandatory when BGP authentication key is specified.	诊断
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	诊断
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.	诊断
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.	诊断
400	InvalidParameter.TagKey	The specified parameter TagKey is invalid.	诊断
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	诊断
400	OperationFailed.NoRamPermission	Vpn Service has no permission to operate your IDaaS instances.	诊断
400	CreateVpnUserGatewayQuotaFull.QuotaFull	The number of created VPN customer gateways exceeds the quota.	诊断
403	Forbidden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	诊断
403	Forbidden	User not authorized to operate on the specified resource.	诊断
409	OperationConflict	The operation against this instance is too frequent, please try again later.	诊断

变更历史

	变更时间	变更内容概要	操作
	2024-01-04	变更错误码400
	2023-10-19	新增请求参数ResourceGroupId 删除返回参数
	2022-12-27	变更错误码400 新增返回参数
	2022-12-27	变更错误码400 变更错误码403

相关示例

用户网关相关操作

创建用户网关->查询已创建的用户网关列表->查询已创建的用户网关->修改用户网关的名称和描述信息->删除指定的用户网关

2022-08-01