GetWorkspace - Retrieve DMS workspace details - Data Management

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:GetWorkspace

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	integer	Yes	The DMS workspace ID.	12****

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID for troubleshooting.	FE8EE2F1-4880-46BC-A704-5CF63EAF****
Message	string	The error message returned on failure.	UnknownError
Data	object	The response data.
WorkspaceId	integer	The workspace ID.	863020290155****
WorkspaceName	string	The workspace name.	workspace_xxx
Description	string	The workspace description.	Test
RegionId	string	The region ID of the workspace.	cn-hangzhou
OwnerId	string	The owner ID.	12345****
ServiceAccountId	string	The service account ID.	12345****
Tid	integer	The tenant ID. Note To view the tenant ID, go to the DMS console and hover over the profile picture in the upper-right corner. View information about the current tenant.	3322****
VpcId	string	The VPC ID.	vpc-xxxx
Success	boolean	Whether the request succeeded. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "FE8EE2F1-4880-46BC-A704-5CF63EAF****",
  "Message": "UnknownError",
  "Data": {
    "WorkspaceId": 0,
    "WorkspaceName": "workspace_xxx",
    "Description": "Test",
    "RegionId": "cn-hangzhou",
    "OwnerId": "12345****",
    "ServiceAccountId": "12345****",
    "Tid": 0,
    "VpcId": "vpc-xxxx"
  },
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
404	WorkspaceNotExist	The specified workspace not exist.	The workspace does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.