批量创建VPN用户

功能介绍

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

调用方法

请参见如何调用API。

URI

请求消息

• 请求参数

  表3 请求参数

  名称	类型	是否必选	描述
  users	Array of CreateVpnUser objects	是	创建VPN用户对象列表。

  表4 CreateVpnUser

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

  • 请求样例

    POST https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users 
    
    {
      "users": [
    	{
    	  "name": "user1",
    	  "password": "******",
    	  "description": "用户描述1",
    	  "user_group_name": "default"
    	},
    	{
    	  "name": "user2",
    	  "password": "******",
    	  "description": "用户描述2",
    	  "user_group_name": "用户组1"
    	}
      ]
    }

响应消息

• 响应参数

  返回状态码为 201: successful operation。

  表5 响应Body参数列表

  名称	类型	描述
  invalid_users	Arrays of InvalidVpnUser Object	无效VPN用户对象列表。如果invalid_users列表不为空，说明本次批量创建用户均失败，请传入正确的请求参数后再重试。
  request_id	String	请求ID。

  表6 InvalidVpnUser

  名称	类型	描述
  name	String	用户名称。
  description	String	用户描述。
  user_group_name	String	所属用户组名称。
  cause	String	原因。

  • 响应样例
    批量创建成功响应样例：

    {
      "invalid_users": [],
      "request_id": "b19ba5a0be8f7b7f664b14596f8f35db"
    }

    存在非法用户请求时的响应样例：

    {
        "invalid_users": [
            {
                "name": "USER1",
                "description": "用户描述",
                "user_group_name": "default",
                "cause": "Duplicate user name."
            },
            {
                "name": "USER2",
                "description": "用户描述",
                "user_group_name": "default",
                "cause": "Password length invalid."
            }
        ],
        "request_id": "49b52ed16992baa4650d093b512a59b6"
    }

状态码

请参见状态码。