产品概述
相关概念
Domain name for API request: organization.intl.tencentcloudapi.com.
This API is used to query the user group list.
A maximum of 20 requests can be initiated per second for this API.
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: ListGroups. |
| Version | Yes | String | Common Params. The value used for this API: 2021-03-31. |
| Region | No | String | Common Params. This parameter is not required. |
| ZoneId | Yes | String | Space ID. |
| NextToken | No | String | Token for querying the next page of returned results. During use of the API for the first time, NextToken is not needed. When you call the API for the first time, if the total number of returned data entries exceeds the MaxResults limit, the data is truncated and only MaxResults data entries are returned. Meanwhile, the return parameter IsTruncated is true and a NextToken is returned. You can use the NextToken returned last time to continue calling the API with other request parameters unchanged, to query the truncated data. You can use this method for multiple queries until IsTruncated is false, indicating that all data has been queried. |
| MaxResults | No | Integer | Maximum number of data entries per page. Value range: 1-100. Default value: 10. |
| Filter | No | String | Filter criterion. Format: |
| GroupType | No | String | User group type. Manual: manually created; Synchronized: externally imported. |
| FilterUsers.N | No | Array of String | Filtered user. IsSelected=1 will be returned for the user group associated with this user. |
| SortField | No | String | Sorting field, which currently only supports CreateTime. The default is the CreateTime field. |
| SortType | No | String | Sorting order. Desc: descending order; Asc: ascending order. It should be set together with SortField. |
| Offset | No | Integer | Pagination offset. Do not use it together with NextToken, prioritizing using NextToken. |
| Parameter Name | Type | Description |
|---|---|---|
| NextToken | String | Token for querying the next page of returned results. Note: This parameter is displayed only when IsTruncated is true. |
| Groups | Array of GroupInfo | User group list. |
| MaxResults | Integer | Maximum number of data entries per page. |
| TotalCounts | Integer | Total number of data entries that meet the request parameter conditions. |
| IsTruncated | Boolean | Whether the returned result is truncated. Valid values: true: truncated; false: not truncated. |
| 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. |
This example shows you how to query the user group list.
POST / HTTP/1.1
Host: organization.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListGroups
<Common request parameters>
{
"ZoneId": "z-32s7dhd8s***",
"MaxResults": 20,
"GroupType": "Manual"
}
{
"Response": {
"NextToken": "OTM0YzE4MzY2ZjdhMWM0MYZD******",
"Groups": [
{
"GroupName": "testGroup",
"Description": "thsi is group",
"CreateTime": "2024-01-01 12:12:12",
"GroupType": "Manual",
"UpdateTime": "2024-01-01 12:12:12",
"GroupId": "g-q8shs8h****",
"MemberCount": 20
}
],
"MaxResults": 10,
"TotalCounts": 30,
"IsTruncated": true,
"RequestId": "e297543a-80de-4039-83c8-9d35d4545"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.IdentityCenterNotOpen | The CIC service is not enabled. |
| FailedOperation.ZoneIdNotExist | The user zoneId of the CIC service does not exist. |
| InvalidParameter.NextTokenInvalid | Invalid nextToken. |
| InvalidParameter.ParamError | Parameter error. |
文档反馈