All Products
Search
Document Center

Security Center:ListGroups

Last Updated:Feb 20, 2024

Queries the server groups.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
zh
CurrentPageintegerNo

The page number. Pages start from page 1. Default value: 1.

89
PageSizeintegerNo

The number of entries per page. Default value: 20. Maximum value: 2000.

10
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. If the return value of NextToken is empty, no next query is to be sent. If a value of NextToken is returned, the value indicates the token that is used for the next query.

1426C575705AE8545E8360A6EFA3B***
UseNextTokenbooleanNo

Specifies whether to use NextToken to query vulnerabilities. If you set this parameter to true, TotalCount is not returned. Valid values:

  • true
  • false
true

Response parameters

ParameterTypeDescriptionExample
object

PageResult

Listobject []

The groups.

GroupIdlong

The server group ID.

11028542
GroupNamestring

The server group name.

cn-shenzhen+dir-1440978***
GroupFlaginteger

The server group type. Valid values:

  • 0: default group
  • 1: other group
1
PageInfoobject

The pagination information.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
TotalCountinteger

The total number of entries returned.

202
Countinteger

The number of entries returned on the current page.

4
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results.

B604532DEF982B875E8360A6EFA3B***
Successboolean

Indicates whether exceptions are handled. Valid values:

  • true
  • false
true
Codestring

The status code.

200
Messagestring

The error message.

successful
RequestIdstring

The request ID.

CB414DB5-F692-5DAB-9F0F-975C060AF***
HttpStatusCodeinteger

The HTTP status code.

200

Examples

Sample success responses

JSONformat

{
  "List": [
    {
      "GroupId": 11028542,
      "GroupName": "cn-shenzhen+dir-1440978***",
      "GroupFlag": 1
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalCount": 202,
    "Count": 4,
    "NextToken": "B604532DEF982B875E8360A6EFA3B***"
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "CB414DB5-F692-5DAB-9F0F-975C060AF***",
  "HttpStatusCode": 200
}

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.