All Products
Search
Document Center

Data Management:AddLhMembers

Last Updated:Nov 28, 2024

Adds a workspace administrator, a workspace member, or a task flow developer in Data Management (DMS).

Operation description

You must call this operation as a DMS administrator, a database administrator (DBA), or a workspace administrator.

Usage notes:

  • Before you call this operation to add a user as a task flow developer, make sure that you have added the user as a workspace member.
  • You cannot call this operation to transfer the ownership of a task flow. To transfer the ownership of a task flow, call the ChangLhDagOwner operation.
  • For more information about workspace roles and permissions, see Manage permissions on a workspace.

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
dms:AddLhMembersupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ObjectTypeintegerYes

The type of the object. Valid values:

  • 0: workspace
  • 1: task flow
0
ObjectIdlongYes

The ID of the object.

  • If the object is a workspace, you can call the GetLhSpaceByName operation to obtain the workspace ID.
  • If the object is a task flow, you can call the ListLhTaskFlowAndScenario operation to obtain the task flow ID.
1
Membersarray<object>Yes

The information about the users to be added.

objectYes
UserIdlongYes

The ID of the user to be added. You can call the ListUsers or GetUser operation to obtain the user ID.

15****
RolesarrayYes

The role. Valid values:

  • ADMIN: workspace administrator. You can add a workspace administrator only as a DMS administrator or a DBA.
  • MEMBER: workspace member.
  • DEVELOPER: task flow developer. Only a workspace member can be added as a task flow developer.
stringYes
ADMIN
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.

3000

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

31853A2B-DC9D-5B39-8492-D2AC8BCF550E
ErrorCodestring

The error code returned if the request fails.

403
ErrorMessagestring

The error message returned if the request fails.

UnknownError
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "31853A2B-DC9D-5B39-8492-D2AC8BCF550E",
  "ErrorCode": "403",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history