CreateWorkspace - Data Management - Alibaba Cloud Documentation Center

Operation description

Prerequisites

A VPC has been created.
You have logged in to the DMS console using an Alibaba Cloud account or a RAM user with sufficient permissions, and have granted DMS permission to access cloud resources with 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

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:CreateWorkspace

create

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceName	string	Yes	The name of the workspace.	workspace_xxx
Description	string	Yes	The description of the workspace.	Test
VpcId	string	Yes	The ID of the VPC.	vpc-xxx
ClientToken	string	No	A client-generated token that you can use to ensure the idempotence of the request. This token must be unique across all requests.	token-xxx

Response elements

Element	Type	Description	Example
	object	Response schema
RequestId	string	The request ID. You can use this ID to troubleshoot issues and trace log data.	4AC23904-55DE-550B-9676-E8946F07****
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
WorkspaceId	integer	The ID of the workspace.	12****

Examples

Success response

JSON format

{
  "RequestId": "4AC23904-55DE-550B-9676-E8946F07****",
  "Success": true,
  "WorkspaceId": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.