查询VPN用户组 - QueryUserGroup

功能介绍

根据VPN用户组ID,查询用户组信息。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

• 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
• 如果使用身份策略授权，需具备如下身份策略权限。

URI

GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id}

请求消息

• 请求参数

  无。

• 请求样例

  GET https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id} 

响应消息

• 响应参数

  返回状态码为 200: 查询成功。

  表2 响应Body参数列表

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

  表3 VpnUserGroup

  名称	类型	描述
  id	String	功能描述：VPN用户组ID。 格式：36位UUID。
  name	String	用户组名称。
  description	String	用户组描述。
  type	String	功能说明：用户组类型。 取值范围： Default：默认用户组。 Custom：用户创建用户组。
  user_number	Integer	用户数量。
  created_at	String	功能说明：创建时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ss.SSSZ。
  updated_at	String	功能说明：更新时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ss.SSSZ。

  • 响应样例

    {
        "user_group": {
            "id": "7625fd92-2e20-4e4d-8c56-66f110fbfaa8",
            "name": "user-group1",
            "description": "用户组1",
            "type": "Custom",
            "user_number": 0,
            "created_at": "2024-06-17T09:48:27.548Z",
            "updated_at": "2024-06-17T09:48:27.548Z"
        },
        "request_id": "6735d32bb3e35e9154caba1dbc6c2dc6"
    }

状态码

请参见状态码。