Obtain the group list - AI Guardrails - Alibaba Cloud Documentation Center

Queries the IDs of all individual groups created in your account.

QPS limits

This operation supports up to 20 queries per second (QPS) per account. Exceeding this limit triggers throttling and may affect your business.

Request syntax

POST /green/sface/groups HTTPS|HTTP

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request parameters

Parameter	Type	Required	Example	Description
clientInfo	JSONObject	No	`{"userId":"120234234","userNick":"Mike","userType":"others"}`	Client information serialized from the ClientInfo structure in JSON format, including the unique machine identifier (UMID) and International Mobile Equipment Identity (IMEI) of the client. For more information, see ClientInfo.

Request body

The request body is not required.

Response parameters

All responses are returned in JSON format. For common response parameters, see Common response parameters.

The data object contains the following fields.

The data field may be empty if an error occurs.

Parameter	Type	Example	Description
code	Integer	200	The HTTP status code. For more information, see Common error codes.
groupIds	StringArray	`["group1","group2"]`	The IDs of all individual groups.

Examples

Sample request

POST /green/sface/groups HTTP/1.1
Common request headers

Sample success response

{
    "msg": "OK",
    "code": 200,
    "requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
    "data": {
        "code": 200,
        "groupIds": [
            "group1",
            "group2"
        ]
    }
}

Error codes

For a list of error codes, see Service error codes.