All Products
Search
Document Center

DataWorks:DsgUserGroupQueryList

Last Updated:Nov 21, 2024

Queries a list of user groups in Data Security Guard.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:DsgUserGroupQueryListlist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerYes

The page number.

1
PageSizeintegerYes

The number of entries per page. Maximum value: 100.

10
NamestringNo

The keyword of the user group name. A fuzzy match is performed based on the keyword to search for the user group.

yun_group
OwnerstringNo

The owner of the user group.

user1
ProjectNamestringNo

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

ParameterTypeDescriptionExample
object

The response parameters.

Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
ErrorCodestring

The error code.

1029030003
ErrorMessagestring

The error message.

param error
HttpStatusCodeinteger

The HTTP status code.

400
PageDataobject

The pagination information.

PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page. Maximum value: 100.

10
TotalCountinteger

The total number of user groups returned.

100
Dataarray<object>

The user groups.

Datasobject
Accountsarray

The usernames in the user group.

AccountListstring

The username.

user1
Idinteger

The user group ID.

123
GmtCreatestring

The time when the user group was created.

2024-05-10 17:14:44
GmtModifiedstring

The time when the user group was modified.

2024-05-10 17:14:44
Namestring

The name of the user group.

test_group
Ownerstring

The owner of the user group.

user1
RequestIdstring

The request ID.

102400001

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 codeError codeError messageDescription
400PARAMS.ERRORparam error.-
400USERGROUP.ACCOUNTLISTSIZE.ERRORThe number of account exceeds the limit.The number of users exceeds the limit
400USERGROUP.ID.ERRORThe 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.
400USERGROUP.LISTSIZE.ERRORThe number of user groups exceeds the limit.The number of user groups exceeds the limit
400USERGROUP.PAGESIZE.ERRORPage size is too large, maximum of 100.Page size limit, up to 100
400USERACCOUNT.OWNER.ERRORUser list or owner user does not exist.User list or responsible user does not exist
403PERMISSION.DENIED.ERRORPermission deniedInsufficient permissions.
500UNKNOWN.ERRORunknown error.Unknown error.

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