Last updated: 2021-01-18 14:23:42

1. API Description

Domain name for API request:

This API is used to get the group information.

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: GetGroupInfo.
Version Yes String Common parameter. The value used for this API: 2020-03-03.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
GroupId Yes String Group ID, which is the GroupId in the CreateGroup API.

3. Output Parameters

Parameter Name Type Description
GroupName String Group name
GroupId String Group ID
GroupExDescriptions Array of String Custom group description field
Tag String Group remarks
FaceModelVersion String Algorithm model version used for face recognition.
CreationTimestamp Integer Group creation time and date (CreationTimestamp), whose value is the number of milliseconds between the UNIX epoch time and the group creation time.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting group information

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "GroupName": "aaa",
    "GroupId": "aaa",
    "GroupExDescriptions": [
    "Tag": "fdsaf",
    "FaceModelVersion": "3.0",
    "CreationTimestamp": 1559530931613,
    "RequestId": "6faa05d0-287b-464e-8755-cf3e8d0c703d"

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

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

Error Code Description
FailedOperation.RequestLimitExceeded The request frequency exceeds the limit.
FailedOperation.RequestTimeout The backend service timed out.
FailedOperation.ServerError The algorithm service is exceptional. Please retry.
InvalidParameterValue.GroupIdIllegal The group ID contains invalid characters. It can contain only letters, digits, and special symbols (-%@#&_).
InvalidParameterValue.GroupIdNotExist The group ID does not exist.
ResourceUnavailable.InArrears The account is in arrears.
ResourceUnavailable.NotExist The billing status is unknown. Please check whether the service has been activated in the console.
ResourceUnavailable.StopUsing The service has been suspended for the account.
ResourcesSoldOut.ChargeStatusException The billing status is exceptional.