Last updated: 2019-12-14 11:27:42


1. API Description

API domain name:

This API queries user group list

Default API request rate limit: 20 requests/sec.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter; the name of this API: ListGroups
Version Yes String Common parameter; the version of this API: 2019-01-16
Region No String Common parameter; optional for this API.
Page No Integer Page number.
Rp No Integer Number of entries per page.
Keyword No String Filter by user group name.

3. Output Parameters

Parameter name Type Description
TotalNum Integer Total number of user groups.
GroupInfo Array of GroupInfo Array information of a user group.
RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Sample

Sample 1. Querying User Group List

Input Sample Code
&<Common request parameter>

Output Sample Code

  "Response": {
    "TotalNum": 2,
    "GroupInfo": [
        "GroupId": 2021,
        "GroupName": "test2",
        "CreateTime": "2019-04-03 15:15:18",
        "Remark": "test2"
        "GroupId": 2020,
        "GroupName": "test1",
        "CreateTime": "2019-04-03 15:11:34",
        "Remark": "test2"
    "RequestId": "dbb91d87-5e3f-42b4-8cc9-ad9f16600370"

5. Developer Resources

API Explorer

This tool provides various capabilities such as online call, signature verification, SDK code generation, and quick API retrieval that significantly reduce the difficulty of using TencentCloud API.

6. Error Codes

This API has no error codes related to business logic. For other error codes, see Common Error Codes.