Last updated: 2021-07-07 11:08:21

    1. API Description

    Domain name for API request:

    This API is used to query the list of user groups.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: ListGroups.
    Version Yes String Common parameter. The value used for this API: 2019-01-16.
    Region No String Common parameter. This parameter is not required for this API.
    Page No Integer Page number; default is 1
    Rp No Integer Number of entries per page; default is 20
    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 User group information array
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying user group list

    Input Example
    &<Common request parameters>

    Output Example

    "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


    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    There is no error code related to the API business logic. For other error codes, please see Common Error Codes.