Creates a workspace for data warehouse development in Data Management (DMS).

  • 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).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateLakeHouseSpace

The operation that you want to perform. Set the value to CreateLakeHouseSpace.

SpaceName String Yes test_space

The name of the workspace.

Description String No test

The description of the workspace.

Mode String Yes 1

The mode in which the workspace runs. Valid values:

  • 0: basic mode. This mode is unavailable.
  • 1: standard mode.
DwDbType String Yes 14

The type of the database. Valid values:

  • 14: AnalyticDB for MySQL
  • 18: AnalyticDB for PostgreSQL
SpaceConfig String Yes {\"skipManualRunCheck\":true,\"skipPublishApprove\":true}

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.
DevDbId String Yes 2435****

The ID of the development database. You can call the ListDatabases or SearchDatabase operation to obtain the ID.

ProdDbId String No 2442****

The ID of the production database. You can call the ListDatabases or SearchDatabase operation to obtain the ID.

Tid Long No 3***

The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.

RegionId String No cn-hangzhou

The ID of the region in which DMS is activated. For more information about the valid values of this parameter, see RegionID parameter.

Response parameters

Parameter Type Example Description
SpaceId Long 24

The ID of the workspace.

RequestId String 7FAD400F-7A5C-4193-8F9A-39D86C4F0231

The ID of the request.

ErrorCode String InvalidParameterValid

The error code returned if the request fails.

ErrorMessage String Invalid parameters: space name, mode, prod db id, db type, and config.

The error message returned if the request fails.

Success Boolean true

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?Action=CreateLakeHouseSpace
&SpaceName=test_space
&Description=test
&Mode=1
&DwDbType=14
&SpaceConfig={\"skipManualRunCheck\":true,\"skipPublishApprove\":true}
&DevDbId=2435****
&ProdDbId=2442****
&Tid=3***
&Common request parameters

Sample responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateLakeHouseSpaceResponse>
    <RequestId>7FAD400F-7A5C-4193-8F9A-39D86C4F0231</RequestId>
    <SpaceId>24</SpaceId>
    <Success>true</Success>
</CreateLakeHouseSpaceResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
  "SpaceId" : 24,
  "Success" : true
}

Error code

For a list of error codes, visit the Error Center.