全部产品
Search

搜索本产品

    数据管理 DMS：GetLhSpaceByName - 查询项目空间信息

    文档中心

    数据管理 DMS：GetLhSpaceByName - 查询项目空间信息

    更新时间：Nov 06, 2024

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

    接口说明

    用户角色为管理员或 DBA。

    调试

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

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    dms:GetLhSpaceByNameget
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    SpaceNamestring是

    项目空间名称。

    		test_space
    Tidlong否

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

    		3000

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

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

    错误码。

    		UnknownError
    ErrorMessagestring

    错误信息。

    		UnknownError
    Successboolean

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

    • true：请求成功
    • false：请求失败
    		true
    LakehouseSpaceobject

    数仓开发项目空间。

    Idlong

    项目空间 ID。

    		1
    SpaceNamestring

    项目空间名称。

    		test_space
    CreatorIdstring

    项目空间创建者的用户 ID。

    		51***
    TenantIdstring

    项目空间所在的租户 ID。

    		3***
    Descriptionstring

    项目空间的描述。

    		test
    Modeinteger

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

    • 0：简单模式
    • 1：标准模式
    		1
    DwDbTypestring

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

    • 14：AnalyticDB MySQL 版
    • 18：AnalyticDB PostgreSQL 版
    		14
    SpaceConfigstring

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

    • skipManualRunCheck：试运行免安全规则检查。
    • skipPublishApprove：发布、运维免审批。
    		{\"skipManualRunCheck\":true,\"skipPublishApprove\":true}
    DevDbIdinteger

    开发库的数据库 ID。

    		2435****
    ProdDbIdinteger

    生产库的数据库 ID。

    		2442****
    IsDeletedboolean

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

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

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史