创建VPN用户

功能介绍

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

调用方法

请参见如何调用API。

URI

请求消息

• 请求参数

  表3 请求参数

  名称	类型	是否必选	描述
  user	CreateVpnUserRequestBodyContent object	是	创建VPN用户请求体对象。

  表4 CreateVpnUserRequestBodyContent

  名称	类型	必选	描述
  name	String	是	功能说明：用户名。 格式：4~32个字符，由英文字母、数字、点、下划线、中划线组成。
  password	String	是	功能说明：用户密码。 约束： 长度范围是8到32个字符。 至少包含以下字符中的2种：大写字母、小写字母、数字、特殊字符`~!@#$%^&*()-_=+\|[{}];:'",<.>/? 和空格。 不能与用户名或倒序的用户名相同。
  description	String	否	功能说明：用户描述。 格式：0-64个字符，由中文、英文、数字和下划线组成。
  user_group_id	String	否	功能说明：所属用户组ID。 格式：36位UUID。

  • 请求样例

    POST https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users 
    
    {
      "user": {
        "name": "user001",
        "password": "******",
        "description": "用户描述1",
        "user_group_id": "yWYnJt0R-Q0a7-R4QW-tFXX-QfundEqrR27W"
      }
    }

响应消息

• 响应参数

  返回状态码为 201: successful operation。

  表5 响应Body参数列表

  名称	类型	描述
  user	user object	VPN用户对象。
  request_id	String	请求ID。

  表6 user

  名称	类型	描述
  id	String	功能说明：VPN用户ID。 格式：36位UUID。

• 响应样例

  {
    "user": {
      "id": "41ad472e-d3e4-482b-8f00-7b2c1bfc4b7d"
    },
    "request_id": "b19ba5a0be8f7b7f664b14596f8f35db"
  }

状态码

请参见状态码。