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

修改VPN用户

功能介绍

根据VPN用户ID,修改指定的用户。

调用方法

请参见如何调用API

URI

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

表1 参数说明

名称

类型

是否必选

描述

project_id

String

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

vpn_server_id

String

VPN服务端ID。

user_id

String

用户ID。

请求消息

  • 请求参数
    表2 请求参数

    名称

    类型

    必选

    描述

    user

    UpdateVpnUserRequestBodyContent object

    更新VPN用户请求对象。

    表3 UpdateVpnUserRequestBodyContent

    名称

    类型

    必选

    描述

    description

    String

    • 功能说明:用户描述。
    • 格式:0-64字符,包含中文、英文、数字、下划线。

    user_group_id

    String

    • 功能说明:所属用户组ID。
    • 格式:36位UUID。
  • 请求样例
    PUT https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users/{user_id}
    
    {
      "user": {
        "description": "用户描述-update",
        "user_group_id": "PTnsQAbZ-KOgW-mCzt-C9Sk-rMM3TcNjQ8wY"
      }
    }

响应消息

  • 响应参数

    返回状态码为 200: successful operation。

    表4 响应Body参数列表

    名称

    类型

    描述

    user

    VpnUser object

    VPN用户对象。

    request_id

    String

    请求ID。

    表5 VpnUser

    名称

    类型

    描述

    id

    String

    • 功能说明:用户ID。
    • 格式:36位UUID。

    name

    String

    用户名称。

    description

    String

    用户描述。

    user_group_id

    String

    • 功能说明:所属用户组ID。
    • 格式:36位UUID。

    user_group_name

    String

    所属用户组名称。

    created_at

    String

    • 功能说明:创建时间。
    • UTC时间格式:yyyy-MM-ddTHH:mm:ssZ

    updated_at

    String

    • 功能说明:更新时间。
    • UTC时间格式:yyyy-MM-ddTHH:mm:ssZ
    • 响应示例
      {
          "user": {
              "id": "41ad472e-d3e4-482b-8f00-7b2c1bfc4b7d",
              "name": "1111",
              "description": "用户描述-update",
              "user_group_id": "PTnsQAbZ-KOgW-mCzt-C9Sk-rMM3TcNjQ8wY",
              "user_group_name": "user-group2",
              "created_at": "2024-06-17T06:53:46.302Z",
              "updated_at": "2024-06-17T08:45:20.973Z"
          },
          "request_id": "380562b4bda6dfe116c42e707d8e9110"
      }

状态码

请参见状态码