Adds or modifies a user group.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dataworks:DsgUserGroupAddOrUpdate | list | *All Resources * |
| none |
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.
| 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.
| |
| 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 |
Response parameters
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.
Change history
| Change time | Summary of changes | Operation |
|---|