Queries a list of user groups in Data Security Guard.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| PageNumber | integer | Yes | The page number. | 1 |
| PageSize | integer | Yes | The number of entries per page. Maximum value: 100. | 10 |
| Name | string | No | The keyword of the user group name. A fuzzy match is performed based on the keyword to search for the user group. | yun_group |
| Owner | string | No | The owner of the user group. | user1 |
| ProjectName | string | No | The name of the compute engine. If you want to query the information about a MaxCompute user group, you need to configure this parameter. | dev_project |
Response parameters
Examples
Sample success responses
JSONformat
{
"Success": true,
"ErrorCode": "1029030003",
"ErrorMessage": "param error",
"HttpStatusCode": 400,
"PageData": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"Data": [
{
"Accounts": [
"user1"
],
"Id": 123,
"GmtCreate": "2024-05-10 17:14:44",
"GmtModified": "2024-05-10 17:14:44",
"Name": "test_group",
"Owner": "user1"
}
]
},
"RequestId": "102400001"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | PARAMS.ERROR | param error. | - |
| 400 | USERGROUP.ACCOUNTLISTSIZE.ERROR | The number of account exceeds the limit. | The number of users exceeds the limit |
| 400 | USERGROUP.ID.ERROR | The user group ID does not match the tenant or does not exist. | The user group ID does not exist or does not belong to the tenant. |
| 400 | USERGROUP.LISTSIZE.ERROR | The number of user groups exceeds the limit. | The number of user groups exceeds the limit |
| 400 | USERGROUP.PAGESIZE.ERROR | Page size is too large, maximum of 100. | Page size limit, up to 100 |
| 400 | USERACCOUNT.OWNER.ERROR | User list or owner user does not exist. | User list or responsible user does not exist |
| 403 | PERMISSION.DENIED.ERROR | Permission denied | Insufficient permissions. |
| 500 | UNKNOWN.ERROR | unknown error. | Unknown error. |
For a list of error codes, visit the Service error codes.