CreateLakeHouseSpace-阿里云帮助中心

Operation description

The workspace name must be unique within a tenant. If a workspace with the same name already exists within the tenant, the call may fail.
You can call the GetLhSpaceByName operation to query whether a workspace with a specific name already exists as a DMS administrator or database administrator (DBA).

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SpaceName	string	Yes	The name of the workspace.	test_space
Description	string	No	The description of the workspace.	test
Mode	string	Yes	The mode in which the workspace runs. Valid values: 0: basic mode. This mode is unavailable. 1: standard mode.	1
DwDbType	string	Yes	The type of the database. Valid values: 14: AnalyticDB for MySQL 18: AnalyticDB for PostgreSQL	14
SpaceConfig	string	Yes	The configuration of the workspace. Valid values: skipManualRunCheck: No security rule check is required in the trial run phase. skipPublishApprove: No approval is required for publishing and O&M.	{\"skipManualRunCheck\":true,\"skipPublishApprove\":true}
DevDbId	string	Yes	The ID of the development database. You can call the ListDatabases or SearchDatabase operation to obtain the ID.	2435****
ProdDbId	string	No	The ID of the production database. You can call the ListDatabases or SearchDatabase operation to obtain the ID.	2442****
Tid	integer	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.	3***

Response elements

Element	Type	Description	Example
	object
SpaceId	integer	The ID of the workspace.	24
RequestId	string	The ID of the request.	7FAD400F-7A5C-4193-8F9A-39D86C4F0231
ErrorCode	string	The error code returned if the request fails.	InvalidParameterValid
ErrorMessage	string	The error message returned if the request fails.	Invalid parameters: space name、mode、prod db id、db type、config.
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true

Examples

Success response

JSON format

{
  "SpaceId": 24,
  "RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
  "ErrorCode": "InvalidParameterValid",
  "ErrorMessage": "Invalid parameters: space name、mode、prod db id、db type、config.",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.