帮你快速理解、总结文档立即下载

创建数据目录

最近更新时间:2026-10-05 01:53:45
我的收藏

1. 接口描述

接口请求域名: databuddy.tencentcloudapi.com 。

创建数据目录接口

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:CreateCatalog。
Version 是 String 公共参数,本接口取值:2026-07-15。
Region 是 String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-jakarta, ap-shanghai, ap-singapore, ap-tokyo 。
Name 是 String catalog名称
示例值:mico_catalog_1025
Type 是 String catalog类型, 可选值TABLE、MODEL、VOLUME
示例值:TABLE
WorkspaceId 是 String 工作空间唯一id
示例值:default
Comment 否 String 描述
示例值:test create
ConnectionId 否 String connection 的 ID
示例值:1
CatalogSource 否 String 数据目录来源,可选(融合版新增字段),取值参考 CatalogSourceEnum:METALAKE(专业版)/ CONNECTION(分析版),不传时默认按 METALAKE 处理
示例值:METALAKE

3. 输出参数

参数名称 类型 描述
Data CreateCatalogRsp 创建catalog响应
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建数据目录

输入示例

POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCatalog
<公共请求参数>

{
    "Name": "my_catalog",
    "Type": "TABLE",
    "WorkspaceId": "17697667906247629",
    "Comment": "这是一个数据目录"
}

输出示例

{
    "Response": {
        "RequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "Data": {
            "CatalogId": "e3f9a474-0f2e-4f93-90e7-b2fc9ec1405c"
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
FailedOperation.DuplicateAnaCatalog 该数据源连接已关联分析版 catalog,同一工作空间下每个 Connection 只能创建一个分析版 Catalog
InternalError.BizException InternalError.BizException
InternalError.FailedOperation InternalError.FailedOperation
InvalidParameter.InvalidParameter 参数不正确
ResourceInUse.CatalogAlreadyExists 数据目录已存在