调用GetLhSpaceByName接口,根据DMS数仓开发项目空间名查询项目空间信息。
接口说明
用户角色为管理员或 DBA。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dms:GetLhSpaceByName |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| SpaceName |
string |
是 |
项目空间名称。 |
test_space |
| Tid |
integer |
否 |
租户 ID,可通过调用接口 GetUserActiveTenant 或 ListUserTenants 获取该参数的值。 |
3000 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
FE8CA4A8-AB2D-55B7-BD30-01A4609F40D8 |
| ErrorCode |
string |
错误码。 |
UnknownError |
| ErrorMessage |
string |
错误信息。 |
UnknownError |
| Success |
boolean |
请求是否成功,返回值如下:
|
true |
| LakehouseSpace |
object |
数仓开发项目空间。 |
|
| Id |
integer |
项目空间 ID。 |
1 |
| SpaceName |
string |
项目空间名称。 |
test_space |
| CreatorId |
string |
项目空间创建者的用户 ID。 |
51*** |
| TenantId |
string |
项目空间所在的租户 ID。 |
3*** |
| Description |
string |
项目空间的描述。 |
test |
| Mode |
integer |
项目空间模式,返回值如下:
|
1 |
| DwDbType |
string |
数据库类型,当前仅支持:
|
14 |
| SpaceConfig |
string |
项目空间配置,支持的配置项:
|
{\"skipManualRunCheck\":true,\"skipPublishApprove\":true} |
| DevDbId |
integer |
开发库的数据库 ID。 |
2435**** |
| ProdDbId |
integer |
生产库的数据库 ID。 |
2442**** |
| IsDeleted |
boolean |
是否已删除。返回值如下:
|
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
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。