调用GetCatalog API获取数据目录详情-数据湖构建-阿里云-数据湖构建(DLF)-阿里云帮助中心

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dlf:GetCatalog

*全部资源

*

无

请求语法

GET /api/metastore/catalogs HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
CatalogId	string	否	数据目录 ID。	catalog_test

返回参数

名称	类型	描述	示例值
	object	返回消息体。
Code	string	状态码描述。	OK
Message	string	响应消息。	.
RequestId	string	请求 ID。	DB07AAE9-4B88-5DEA-8F1D-4D1A9A864A85
Success	boolean	调用是否成功。	true
Catalog	Catalog	Catalog 详情。	参考Catalog实体

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": ".",
  "RequestId": "DB07AAE9-4B88-5DEA-8F1D-4D1A9A864A85",
  "Success": true,
  "Catalog": {
    "CatalogId": "1344371",
    "Description": "测试",
    "LocationUri": "oss://dlf-test-oss-location/",
    "Owner": "acs:ram::[accountId]:root",
    "CreatedBy": "acs:ram::[accountId]:root\n",
    "CreateTime": 1640662815,
    "UpdateTime": 1640662815,
    "Status": "CREATED",
    "CatalogType": "HMS",
    "DefaultCatalog": true,
    "ThriftEnabled": true,
    "JdbcEnabled": true,
    "StorageAccessConfig": ""
  }
}

错误码

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

变更历史

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