GetLhSpaceByName - Data Management - Alibaba Cloud Documentation Center

Queries the information about a workspace based on the workspace name in Data Management (DMS).

Operation description

You are a DMS administrator or a database administrator (DBA).

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
SpaceName	string	Yes	The name of the workspace.	test_space
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.	3000

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	FE8CA4A8-AB2D-55B7-BD30-01A4609F40D8
ErrorCode	string	The error code returned if the request fails.	UnknownError
ErrorMessage	string	The error message returned if the request fails.	UnknownError
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true
LakehouseSpace	object	The workspace for data warehouse development.
Id	long	The ID of the workspace.	1
SpaceName	string	The name of the workspace.	test_space
CreatorId	string	The ID of the user who creates the workspace.	51***
TenantId	string	The ID of the tenant to which the workspace belongs.	3***
Description	string	The description of the workspace.	test
Mode	integer	The mode in which the workspace runs. Valid values: 0: basic mode 1: standard mode	1
DwDbType	string	The type of the database. Valid values: 14: AnalyticDB for MySQL 18: AnalyticDB for PostgreSQL	14
SpaceConfig	string	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	integer	The ID of the development database.	2435****
ProdDbId	integer	The ID of the production database.	2442****
IsDeleted	boolean	Indicates whether the workspace is deleted. Valid values: true: The workspace is deleted. false: The workspace is not deleted.	false

Examples

Sample success responses

JSONformat

{
  "RequestId": "FE8CA4A8-AB2D-55B7-BD30-01A4609F40D8",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "LakehouseSpace": {
    "Id": 1,
    "SpaceName": "test_space",
    "CreatorId": "51***",
    "TenantId": "3***",
    "Description": "test",
    "Mode": 1,
    "DwDbType": "14",
    "SpaceConfig": "{\\\"skipManualRunCheck\\\":true,\\\"skipPublishApprove\\\":true}",
    "DevDbId": 0,
    "ProdDbId": 0,
    "IsDeleted": false
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history