文档首页/ 虚拟专用网络 VPN/ API参考/ 应用示例/ 示例二:创建对端网关
更新时间:2024-07-18 GMT+08:00

示例二:创建对端网关

操作场景

本章节指导用户通过调用API来创建对端网关。

前提条件

当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。Token认证,具体操作请参考认证鉴权章节。

通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。

数据准备

表1 创建对端网关请求关键参数

参数

说明

取值样例

name

对端网关名称。

stub-customer-gateway-id-1

route_mode

网关路由模式。

static

ip

对端网关ip地址。

10.12.13.21

操作步骤

  1. 创建对端网关。
    1. 发送“POST https://{endpoint}/v5/{project_id}/customer-gateways”,project_id为项目ID。
    2. 在Request Header中增加“X-Auth-Token”。
    3. 在Request Body中传入参数如下。
      {
          "customer_gateway": {
              "name": "cgw-3ebf",
              "id_type": "ip",
              "id_value": "10.***.***.21"
          }
      }
    4. 查看请求响应结果。
      • 请求成功时,响应参数如下,id就是对端网关的ID。
         1
         2
         3
         4
         5
         6
         7
         8
         9
        10
        11
        {
            "customer_gateway": {
                "id": "03c0aa3d-demo-a8df-va86-9d82473765d4",
                "name": "cgw-3ebf",
                "id_type": "ip",
                "id_value": "10.***.***.21",
                "created_at": "2021-12-21T16:49:28.108+08:00",
                "updated_at": "2021-12-21T16:49:28.108+08:00"
            },
            "request_id": "e55783ba-5cc8-40c1-ad81-12cce6f773d2"
        }
        
  2. 查询对端网关详情。
    1. 发送“GET https://{endpoint}/v5/{project_id}/customer-gateways/{customer_gateway_id}”,project_id为项目ID。
    2. 在Request Header中增加“X-Auth-Token”。
    3. 查看请求响应结果。
      • 请求成功时,响应参数如下,id就是对端网关的ID。
         1
         2
         3
         4
         5
         6
         7
         8
         9
        10
        11
        {
            "customer_gateway": {
                "id": "03c0aa3d-demo-a8df-va86-9d82473765d4",
                "name": "cgw-3ebf",
                "id_type": "ip",
                "id_value": "10.***.***.21",
                "created_at": "2021-12-21T16:49:28.108+08:00",
                "updated_at": "2021-12-21T16:49:28.108+08:00"
            },
            "request_id": "8cf476c4-c3d4-4516-bfbc-01e2473e549b"
        }