调用GetCatalog获取数据目录详情-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:GetCatalog

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Id	string	是	数据目录实体 ID，当前支持 dlf 与 starrocks 类型，可参考 ListCatalogs 接口返回结果，以及元数据实体相关概念说明。对于 dlf 类型，格式为 `dlf-catalog::catalog_id` 对于 starrocks 类型，格式为`starrocks-catalog:(instance_id\|encoded_jdbc_url):catalog_name` 说明其中 `catalog_id`: dlf 目录 id `instance_id`: 实例 ID，对应数据源以实例模式注册时需要提供 `encoded_jdbc_url`: JDBC 连接串的 URLEncode 编码,对应数据源以连接串方式注册时需要提供 `catalog_name`: starrocks 目录名称	dlf-catalog::catalog_id

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	1AFAE64E-D1BE-432B-A9****
Success	boolean	请求是否成功。	true
Catalog	Catalog	数据目录信息。

示例

正常返回示例

JSON格式

{
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Success": true,
  "Catalog": {
    "Id": "",
    "Name": "",
    "Comment": "",
    "Type": "",
    "CreateTime": 0,
    "ModifyTime": 0,
    "ParentMetaEntityId": ""
  }
}

错误码

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

变更历史

更多信息，参考变更详情。