ListWorkspaceUsers

Operation description

Prerequisites

A VPC has been created.
You have logged on to the DMS console with an Alibaba Cloud account (main account) or a RAM user with administrative privileges, and have granted the AliyunDMSProcessingDataRolePolicy permission to DMS to access cloud resources.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The ID of the workspace.	12****
PageNum	string	No	The page number.	1
MaxResults	integer	No	The maximum number of entries to return on each page. You can use this parameter with `NextToken` to implement pagination.	20
NextToken	string	No	The token used to retrieve the next page of results. For the first request, leave this parameter empty. For subsequent requests, set this parameter to the NextToken value returned in the previous response.	f056501ada12c1cc

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The ID of the request.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Success	boolean	Indicates whether the request was successful.	true
TotalCount	string	The total number of matching entries.	1
Data	array<object>	The list of users.
	object	Details of a user.
DmsUserId	integer	The ID of the DMS user.	12345
NickName	string	The nickname of the user.	dynamic_320514_20250429102514
LoginName	string	The login name of the user.	li
MaxResults	integer	The maximum number of entries returned on each page, as specified in the request.	20
NextToken	string	The token to use to retrieve the next page of results. If this parameter is empty, all results have been returned.	NesLoKLEdIZrKhDT7I2gS****

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "Success": true,
  "TotalCount": "1",
  "Data": [
    {
      "DmsUserId": 12345,
      "NickName": "dynamic_320514_20250429102514",
      "LoginName": "li"
    }
  ],
  "MaxResults": 20,
  "NextToken": "NesLoKLEdIZrKhDT7I2gS****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.