更新时间:2024-08-23 GMT+08:00

修改VPN服务端

功能介绍

根据VPN服务端ID,修改指定的VPN服务端。

调用方法

请参见如何调用API

URI

PUT /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}

表1 参数说明

名称

类型

是否必选

描述

project_id

String

项目ID,可以通过获取项目ID获取项目ID

vpn_server_id

String

VPN服务端ID

请求消息

  • 请求参数
    表2 请求参数

    名称

    类型

    必选

    描述

    vpn_server

    UpdateServerRequest object

    更新VPN服务端请求对象

    表3 UpdateServerRequest

    名称

    类型

    必选

    描述

    client_cidr

    String

    • 功能说明:客户端网段。客户端建立连接时,会从该网段分配一个虚拟IP地址
    • 格式:"点分十进制/掩码"格式,例如192.168.1.0/24
    • 约束:
      • 客户端网段不能和网关所在VPC默认路由表中的路由存在冲突
      • 客户端网关不能和本服务端中本端网段列表的网段存在冲突
      • 客户端网段地址池的IP地址数量需大于网关最大连接数的四倍
      • 客户端网段不能使用以下特殊网段:0.0.0.0/8, 127.0.0.0/8, 224.0.0.0/4, 240.0.0.0/4, 169.254.0.0/16

    local_subnets

    Array of strings

    • 功能说明:本端网段列表。本端子网是云上子网,该子网需要通过VPN与云下对端子网进行互通。
    • 格式:"点分十进制/掩码"格式,例如10.10.1.0/24
    • 约束:
      • 至少有一个本端网段,默认最多支持填写10个网段
      • 本地网段不能使用以下特殊网段:0.0.0.0/8, 127.0.0.0/8, 224.0.0.0/4, 240.0.0.0/4

    server_certificate

    server_certificate object

    服务端证书,推荐使用强密码算法的证书,如RSA3072/4096。

    ssl_options

    ssl_options object

    SSL隧道协议的可选配置项

    client_auth_type

    String

    • 功能说明:客户端认证类型
    • 取值范围:

      CERT:证书认证

      LOCAL_PASSWORD:口令认证(本地)

    表4 server_certificate

    名称

    类型

    必选

    描述

    id

    String

    功能说明:证书ID,为CCM(云证书管理服务)中已上传证书的证书ID。

    表5 ssl_options

    名称

    类型

    必选

    描述

    protocol

    String

    • 功能说明:协议
    • 取值范围:
      • TCP
    • 默认值:TCP

    port

    Integer

    • 功能说明:端口号
    • 取值范围:
      • 443
      • 1194
    • 默认值:443

    encryption_algorithm

    String

    • 功能说明:加密算法
    • 取值范围:
      • AES-128-GCM
      • AES-256-GCM
    • 默认值:AES-128-GCM
  • 请求样例
    PUT https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}
    
    {
      "vpn_server": {
        "client_cidr": "192.168.10.0/24",
        "local_subnets": [
          "172.16.0.0/24",
          "172.16.1.0/24"
        ],
        "server_certificate": {
          "id": "scs1717051012106"
        },
        "ssl_options": {
          "protocol": "TCP",
          "port": 443,
          "encryption_algorithm": "AES-128-GCM"
        },
        "client_auth_type": "CERT"
      }
    }

响应消息

  • 响应参数

    返回状态码为 200: successful operation。

    表6 响应Body参数列表

    名称

    类型

    描述

    request_id

    string

    请求id

  • 响应示例
    {
      "request_id": "c63d850876bcddbdfbd11776cce57914"
    }

状态码

请参见状态码