功能介绍
创建租户用于与VPN网关相连的对端网关
URI
POST /v5/{project_id}/customer-gateways
名称 |
类型 |
是否必选 |
说明 |
---|---|---|---|
project_id |
String |
是 |
项目ID,可以通过获取项目ID获取项目ID |
请求消息
- 请求参数
表3 CreateCgwRequestBodyContent 名称
类型
是否必选
描述
name
String
否
- 功能说明:对端网关名称,不填时会自动生成格式为cgw-****的名称。例如:cgw-21a3。
- 取值范围:1-64个字符,支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。
route_mode
String
否
- 功能说明:对端网关路由模式
- 取值范围:static,bgp。
- 默认值:bgp
bgp_asn
Long
否
- 功能说明:对端网关的BGP自治域编号
- 取值范围:1-4294967295
- 默认值:65000
- 约束:当route_mode为bgp时填写,否则不填。
ip
String
是
- 功能说明:对端网关 ip地址
- 取值范围:ipv4地址类型。例如:10.***.***.21。
ca_certificate
否
- 功能说明:对端网关CA证书,创建国密型对端网关时需上传。
- 请求样例
POST https://{Endpoint}/v5/{project_id}/vpn/customer-gateways { "customer_gateway": { "name": "cgw-2abf", "route_mode": "bgp", "bgp_asn": 65000, "ip": "10.***.***.21" "ca_certificate": { "content":"******" } } }
响应消息
- 响应参数
表5 响应Body参数列表 名称
类型
描述
customer_gateway
customer_gateway对象
request_id
String
请求id
表6 ResponseCustomerGateway 名称
类型
描述
id
String
- 功能说明:对端网关的ID
- 格式:36位UUID
name
String
- 功能说明:对端网关名称,不填时会自动生成。
- 取值范围:1-64个字符,包括数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。
route_mode
String
- 功能说明:对端网关路由模式
- 取值范围:static,bgp。
bgp_asn
Long
对端网关的BGP自治域编号。仅当route_mode为bgp时返回。
ip
String
- 功能说明:对端网关ip地址
- 格式:ipv4类型地址。例如:10.***.***.21。
ca_certificate
对端网关CA证书信息。仅当对端网关绑定CA证书时返回。
created_at
String
创建时间
updated_at
String
最后一次更新时间
- 响应样例
{ "customer_gateway": { "id": "03c0aa3d-****-****-****-9d82473765d4", "name": "cgw-2abf", "route_mode": "bgp", "bgp_asn": 65000, "ip": "10.***.***.21", "ca_certificate": { "serial_number": "14257156674311863338", "signature_algorithm": "SM3WITHSM2", "issuer": "C=CN,O=a0002,CN=XXX", "subject": "C=CN,O=a0002,CN=XXX", "expire_time": "2024-05-22T07:34:22Z", "is_updatable": true }, "created_at": "2021-12-21T16:49:28.108+08:00", "updated_at": "2021-12-21T16:49:28.108+08:00" }, "request_id": "7e0383bf-a7fb-461b-a926-baa8a795bf1a" }
状态码
请参见状态码