DsgUserGroupQueryList - - Alibaba Cloud Documentation Center

Queries a list of user groups in Data Security Guard.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DsgUserGroupQueryList	The operation that you want to perform. Set the value to DsgUserGroupQueryList.
PageNumber	Integer	Yes	1	The page number.
PageSize	Integer	Yes	10	The number of entries per page. Valid values: 1 to 100.
Name	String	No	yun_group	The keyword of the user group name. A fuzzy match is performed based on the keyword to search for the user group.
Owner	String	No	user1	The owner of the user group.
ProjectName	String	No	dev_project	The name of the compute engine. If you want to query the information about a MaxCompute user group, you need to configure this parameter.

Response parameters

Parameter	Type	Example	Description
Success	Boolean	true	Indicates whether the request was successful. Valid values: true false
ErrorCode	String	1029030003	The error code.
ErrorMessage	String	param error	The error message.
HttpStatusCode	Integer	400	The HTTP status code.
PageData	Object		The pagination information.
PageNumber	Integer	1	The page number.
PageSize	Integer	10	The number of entries per page. Valid values: 1 to 100.
TotalCount	Integer	100	The total number of user groups.
Data	Array of Datas		The user groups.
Accounts	Array of String	user1	The username.
Id	Integer	123	The user group ID.
GmtCreate	String	2024-05-10 17:14:44	The time when the user group was created.
GmtModified	String	2024-05-10 17:14:44	The time when the user group was modified.
Name	String	test_group	The name of the user group.
Owner	String	user1	The owner of the user group.
RequestId	String	102400001	The request ID. You can use the ID to locate logs and troubleshoot issues.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DsgUserGroupQueryList
&PageNumber=1
&PageSize=10
&Name=yun_group
&Owner=user1
&ProjectName=dev_project
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DsgUserGroupQueryListResponse>
    <Success>true</Success>
    <ErrorCode>1029030003</ErrorCode>
    <ErrorMessage>param error</ErrorMessage>
    <HttpStatusCode>400</HttpStatusCode>
    <PageData>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>100</TotalCount>
        <Data>
            <Accounts>user1</Accounts>
            <Id>123</Id>
            <GmtCreate>2024-05-10 17:14:44</GmtCreate>
            <GmtModified>2024-05-10 17:14:44</GmtModified>
            <Name>test_group</Name>
            <Owner>user1</Owner>
        </Data>
    </PageData>
    <RequestId>102400001</RequestId>
</DsgUserGroupQueryListResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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

HttpCode	Error code	Error message	Description
400	PARAMS.ERROR	param error.	The values specified for one or more parameters are invalid.
400	USERGROUP.ACCOUNTLISTSIZE.ERROR	The number of account exceeds the limit.	The number of users exceeds the upper 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 upper limit.
400	USERGROUP.PAGESIZE.ERROR	Page size is too large, maximum of 100.	The number of entries per page exceeds the upper limit. The maximum number of entries per page is 100.
400	USERACCOUNT.OWNER.ERROR	User list or owner user does not exist.	The user list or the owner of users does not exist.
403	PERMISSION.DENIED.ERROR	Permission denied	You are not authorized to perform this operation.
500	UNKNOWN.ERROR	unknown error.	An unknown error has occurred.

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