DsgUserGroupAddOrUpdate - DataWorks - Alibaba Cloud Documentation Center

Adds or modifies a user group.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
UserGroups	array<object>	Yes	The information about the user group.
	object	Yes
Id	long	No	The user group ID. If you do not configure this parameter, the current operation is to add a user group. If you configure this parameter, the current operation is to modify a user group. You can call the DsgUserGroupQueryList operation to query the user group ID.	123
Name	string	Yes	The name of the user group.	yun_group
Owner	string	Yes	The owner of the user group.	user1
Accounts	array	Yes	The users in the group. If a user group is created by using an Alibaba Cloud account and a RAM role, you can call the DsgUserGroupQueryUserList operation to query the users in the group. If a user group is created by using a MaxCompute role, you can call the DsgUserGroupQueryUserList operation to query the users in the group.
	string	No	The username or MaxCompute role. This parameter must be configured based on the value of the UserGroupType parameter.	user1
ProjectName	string	No	The name of the MaxCompute project. You must configure this parameter when you create a MaxCompute user group.	dev_project
UserGroupType	integer	Yes	The type of the user group. Valid values: 1: Alibaba Cloud account 2: RAM role 3: MaxCompute role	1

Response parameters

Parameter	Type	Description	Example
	object	OpenApiResultModel
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrorCode	string	The error code.	1029030003
ErrorMessage	string	The error message.	param error
HttpStatusCode	integer	The HTTP status code.	400
Data	boolean	The operation result. Valid values: true: The operation is successful. false: The operation fails.	true
RequestId	string	The request ID. You can use the ID to locate logs and troubleshoot issues.	102400001

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "Data": true,
  "RequestId": "102400001"
}

Error codes

HTTP status code	Error code	Error message	Description
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
400	PARAMS.ERROR	param error.	-
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.