All Products
Search
Document Center

Data Management:GetLhSpaceByName

Last Updated:Nov 28, 2024

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:GetLhSpaceByNameget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SpaceNamestringYes

The name of the workspace.

test_space
TidlongNo

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

3000

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The error code returned if the request fails.

UnknownError
ErrorMessagestring

The error message returned if the request fails.

UnknownError
Successboolean

Indicates whether the request is successful. Valid values:

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

The workspace for data warehouse development.

Idlong

The ID of the workspace.

1
SpaceNamestring

The name of the workspace.

test_space
CreatorIdstring

The ID of the user who creates the workspace.

51***
TenantIdstring

The ID of the tenant to which the workspace belongs.

3***
Descriptionstring

The description of the workspace.

test
Modeinteger

The mode in which the workspace runs. Valid values:

  • 0: basic mode
  • 1: standard mode
1
DwDbTypestring

The type of the database. Valid values:

  • 14: AnalyticDB for MySQL
  • 18: AnalyticDB for PostgreSQL
14
SpaceConfigstring

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}
DevDbIdinteger

The ID of the development database.

2435****
ProdDbIdinteger

The ID of the production database.

2442****
IsDeletedboolean

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 timeSummary of changesOperation
No change history