调用GetLhSpaceByName接口，根据DMS数仓开发项目空间名查询项目空间信息。

用户角色为管理员或DBA。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 GetLhSpaceByName

系统规定参数。取值：GetLhSpaceByName。

SpaceName String 是 test_space

项目空间名称。
Tid Long 否 3000

租户ID，可通过调用接口GetUserActiveTenant或ListUserTenants获取该参数的值。

RegionId String 否 cn-hangzhou

DMS服务地域，取值请参见RegionID参数说明。

返回数据

名称 类型 示例值 描述
RequestId String FE8CA4A8-AB2D-55B7-BD30-01A4609F40D8

请求ID。
ErrorCode String UnknownError

错误码。
ErrorMessage String UnknownError

错误信息。
Success Boolean true

请求是否成功，返回值如下：

  • true：请求成功
  • false：请求失败
LakehouseSpace Object

数仓开发项目空间。
Id Long 1

项目空间ID。
SpaceName String test_space

项目空间名称。
CreatorId String 51***

项目空间创建者的用户ID。
TenantId String 3***

项目空间所在的租户ID。
Description String test

项目空间的描述。
Mode Integer 1

项目空间模式，返回值如下：

  • 0：简单模式
  • 1：标准模式
DwDbType String 14

数据库类型，当前仅支持：

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

项目空间配置，支持的配置项：

  • skipManualRunCheck：试运行免安全规则检查。
  • skipPublishApprove：发布、运维免审批。
DevDbId Integer 2435****

开发库的数据库ID。
ProdDbId Integer 2442****

生产库的数据库ID。
IsDeleted Boolean false

是否已删除。返回值如下：

  • true：项目空间已删除
  • false：项目空间没有被删除

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=GetLhSpaceByName
&SpaceName=test_space
&Tid=3***
&公共请求参数

正常返回示例

XML格式 

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格式 

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
}

错误码

访问错误中心查看更多错误码。