文档首页/ 虚拟专用网络 VPN/ API参考/ API/ 终端入云VPN API/ 用户管理/ 创建VPN用户组
更新时间：2024-08-02 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建VPN用户组

功能介绍

在指定VPN服务端下，创建VPN用户组。

调用方法

请参见如何调用API。

URI

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

名称

类型

是否必选

描述

project_id

String

是

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

vpn_server_id

String

是

VPN服务端ID
表2 请求Header参数列表

名称

类型

是否必选

描述

X-Client-Token

String

否
  • 功能说明：幂等性标识
  • 格式：36位UUID

请求消息

  • 请求参数
    表3 请求参数

    名称

    类型

    是否必选

    描述

    user_group

    CreateVpnUserGroupRequestBodyContent object

    是

    创建VPN用户组请求体对象
    表4 CreateVpnUserGroupRequestBodyContent

    名称

    类型

    必选

    描述

    name

    String

    是
    • 功能说明：用户组名
    • 格式：1到64个字符，可使用中文、英文字母、数字、下划线、中划线
    • 约束
      • 用户组名不能重复

    description

    String

    否
    • 功能说明：用户组描述
    • 格式：0到64个字符，可使用中文、大写字母、小写字母、数字、特殊字符`~!@#$%^&*()-_=+\|[{}];:'",<.>/?
    • 请求样例 
      POST https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups 

{
  "user_group": {
    "name": "user-group1",
    "description": "用户组1"
  }
}

响应消息

  • 响应参数

    返回状态码为 201: successful operation。

    表5 响应Body参数列表

    名称

    类型

    描述

    user_group

    user_group object

    用户组对象

    request_id

    String

    请求id
    表6 user_group

    名称

    类型

    描述

    id

    String
    • 功能说明：VPN用户组ID
    • 格式：36位UUID
  • 响应样例 
    {
    "user_group": {
        "id": "7625fd92-2e20-4e4d-8c56-66f110fbfaa8"
    },
    "request_id": "94d271493e144135423e7377e40127cf"
}

状态码

请参见状态码。

父主题： 用户管理

相关文档