SearchWorkspaceRoles

Searches for roles in a workspace.

Operation description

Prerequisites

A VPC has been created.
You have logged in to the DMS console as an Alibaba Cloud account or a RAM user with high-level permissions and have granted DMS access to cloud resources by using the AliyunDMSProcessingDataRolePolicy policy.

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****
ClientToken	string	No	An idempotent token used to ensure request idempotency.	123
SearchKey	string	No	The keyword used for the search. Fuzzy search is supported.	test
MaxResults	integer	No	The maximum number of entries to return on a single page.	20
NextToken	string	No	The token used to retrieve the next page of results. Set this parameter to the NextToken value returned in the previous response.	f056501ada12c1cc

Response elements

Element	Type	Description	Example
	object	The response schema.
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 entries that meet the search criteria. This parameter is optional and is not returned by default.	1
Data	array<object>	A list of the returned roles.
	object	The dataset.
RoleId	integer	The ID of the role. Note	MANAGER
RoleName	string	The name of the role.	SLBLogDefaultRole
RoleSource	string	The source of the role.	INNER
RoleSourceName	string	The name of the source.	inner
MaxResults	integer	The maximum number of entries returned on each page.	20
NextToken	string	The token used to retrieve the next page of results. This parameter is omitted if no more results are available.	NesLoKLEdIZrKhDT7I2gS****

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "Success": true,
  "TotalCount": "1",
  "Data": [
    {
      "RoleId": 0,
      "RoleName": "SLBLogDefaultRole",
      "RoleSource": "INNER",
      "RoleSourceName": "inner"
    }
  ],
  "MaxResults": 20,
  "NextToken": "NesLoKLEdIZrKhDT7I2gS****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.