tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeGroup

Last updated: 2024-04-01 19:34:32

    1. API Description

    Domain name for API request: lcic.tencentcloudapi.com.

    This API is used to get the details of a group.
    A maximum of 20 requests can be initiated per second for this API.

    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 Params. The value used for this API: DescribeGroup.
    Version Yes String Common Params. The value used for this API: 2022-08-17.
    Region No String Common Params. This parameter is not required.
    GroupId Yes String The group ID.
    SdkAppId Yes Integer The SDKAppID assigned by LCIC.

    3. Output Parameters

    Parameter Name Type Description
    GroupId String The group ID.
    GroupName String The group name.
    TeacherId String
    Note: This field may return null, indicating that no valid values can be obtained.
    GroupType Integer The group type. 0: Ordinary group. 1: Merged group. If the group queried is a merged group, the IDs of the sub-groups will be returned.
    SubGroupIds Array of String
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Getting the details of a group

    This example shows you how to get the details of a group.

    Input Example

    {
    "GroupId": "abcdfdfg",
   "SdkAppId": 12345678
}

    Output Example

    {
    "Response": {
        "GroupId": "xx",
        "GroupName": "xx",
        "TeacherId": "xx",
        "GroupType": 1,
        "SubGroupIds": [
            "xx"
        ],
        "RequestId": "xx"
    }
}

    5. Developer Resources

    SDK

    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

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    AuthFailure CAM signature/authentication error.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameter.Content Prohibited content (pornographic, terrorist, politically sensitive) detected.
    InvalidParameter.GroupParamInvalid Parameter error. The teacher and group members are not specified.
    InvalidParameter.SdkAppId SdkAppId is incorrect.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter.
    ResourceNotFound.GroupNotExist The group does not exist.
    ResourceUnavailable The resource is unavailable.
    UnauthorizedOperation Unauthorized operation.
    UnknownParameter Unknown parameter error.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy