更新时间:2024-11-29 GMT+08:00

创建VPN访问策略

功能介绍

在指定VPN服务端下,创建访问策略。

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/access-policies
表1 参数说明

名称

类型

是否必选

描述

project_id

String

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

vpn_server_id

String

VPN服务端ID。

表2 请求Header参数列表

名称

类型

是否必选

描述

X-Client-Token

String

  • 功能说明:幂等性标识。
  • 格式:36位UUID。

请求消息

  • 请求参数
    表3 请求参数

    名称

    类型

    是否必选

    描述

    access_policy

    CreateVpnAccessPolicyRequestBodyContent object

    创建VPN访问策略请求体对象。

    表4 CreateVpnAccessPolicyRequestBodyContent

    名称

    类型

    是否必选

    描述

    name

    String

    • 功能描述:访问策略名。

    user_group_id

    String

    • 功能描述:VPN用户组ID。
    • 格式:36位UUID。

    description

    String

    访问策略描述。

    dest_ip_cidrs

    Array of strings

    • 功能描述:目的IP网段列表。
    • 格式:"点分十进制/掩码"格式,例如192.168.1.0/24。
    • 约束:至少有1个网段,至多10个。
    • 请求样例
      POST https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/access-policies
      
      {
          "access_policy": {
              "name": "policy-001",
              "user_group_id": "7625fd92-2e20-4e4d-8c56-66f110fbfaa8",
              "description": "访问策略1",
              "dest_ip_cidrs": [
                "172.16.0.0/24",
                "172.16.1.0/24"
              ]
          }
      }

响应消息

  • 响应参数

    返回状态码为 201: successful operation。

    表5 响应Body参数列表

    名称

    类型

    描述

    access_policy

    access_policy object

    访问策略对象。

    request_id

    String

    请求ID。

    表6 access_policy

    名称

    类型

    描述

    id

    String

    • 功能描述:访问策略ID。
    • 格式:36位UUID。
  • 响应样例
    {
        "access_policy": {
            "id": "4f746482-a575-4e1f-9e80-5f6f69ff8588"
        },
        "request_id": "1663cd8cacbb3497ebc88877e5a3ad89"
    }

状态码

请参见状态码