GetLhSpaceByName -

You are a DMS administrator or a 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	GetLhSpaceByName	The operation that you want to perform. Set the value to GetLhSpaceByName.
SpaceName	String	Yes	test_space	The name of the workspace.
Tid	Long	No	3000	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, see RegionID parameter.

Response parameters


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

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?Action=GetLhSpaceByName
&SpaceName=test_space
&Tid=3***
&Common request parameters

Sample responses

XML format

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

<GetLhSpaceByNameResponse>
    <RequestId>FE8CA4A8-AB2D-55B7-BD30-01A4609F40D8</RequestId>
    <LakehouseSpace>
        <TenantId>3***</TenantId>
        <IsDeleted>false</IsDeleted>
        <SpaceName>test_space</SpaceName>
        <CreatorId>51***</CreatorId>
        <Mode>1</Mode>
        <DwDbType>14</DwDbType>
        <Id>1</Id>
        <SpaceConfig>{"skipManualRunCheck":true,"skipPublishApprove":true}</SpaceConfig>
        <DevDbId>2435****</DevDbId>
        <ProdDbId>2442****</ProdDbId>
    </LakehouseSpace>
    <Success>true</Success>
</GetLhSpaceByNameResponse>

JSON format

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

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

Error code

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