All Products
Search

This Product

    Data Management:GetLhSpaceByName

    Document Center

    Data Management:GetLhSpaceByName

    Last Updated:Aug 05, 2026

    Queries the information about a DMS data warehouse development project workspace by workspace name.

    Operation description

    The user role must be administrator or 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:GetLhSpaceByName

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    SpaceName

    string

    Yes

    The name of the project workspace.

    test_space
    Tid

    integer

    No

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

    3000

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    FE8CA4A8-AB2D-55B7-BD30-01A4609F40D8
    ErrorCode

    string

    The error code.

    UnknownError
    ErrorMessage

    string

    The error message.

    UnknownError
    Success

    boolean

    Indicates whether the request is successful. Valid values:

    • true: The request is successful.

    • false: The request fails.

    true
    LakehouseSpace

    object

    The data warehouse development project workspace.

    Id

    integer

    The ID of the project workspace.

    1
    SpaceName

    string

    The name of the project workspace.

    test_space
    CreatorId

    string

    The user ID of the project workspace creator.

    51***
    TenantId

    string

    The tenant ID of the project workspace.

    3***
    Description

    string

    The description of the project workspace.

    test
    Mode

    integer

    The mode of the project workspace. Valid values:

    • 0: simple mode

    • 1: standard mode

    1
    DwDbType

    string

    The database type. Currently, only the following types are supported:

    • 14: AnalyticDB for MySQL

    • 18: AnalyticDB for PostgreSQL

    14
    SpaceConfig

    string

    The project workspace configuration. The following configuration items are supported:

    • skipManualRunCheck: Skips security rule checks for trial runs.

    • skipPublishApprove: Skips approval for publishing and O&M operations.

    {\"skipManualRunCheck\":true,\"skipPublishApprove\":true}
    DevDbId

    integer

    The database ID of the development database.

    2435****
    ProdDbId

    integer

    The database ID of the production database.

    2442****
    IsDeleted

    boolean

    Indicates whether the project workspace is deleted. Valid values:

    • true: The project workspace is deleted.

    • false: The project workspace is not deleted.

    false

    Examples

    Success response

    JSON format

    {
  "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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.