1. 接口描述
接口请求域名： tccatalog.tencentcloudapi.com 。
获取Tcc数据目录列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTccCatalogs。 |
| Version | 是 | String | 公共参数，本接口取值：2024-10-24。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| CatalogId | 否 | String | 数据目录Id 示例值：b8sd7dd7-ekd4-4e5e-993e-e5db64fa21c1 |
| Name | 否 | String | 数据目录名称 示例值：TccHiveCatalog |
| Type | 否 | String | 数据目录类型,当前支持：TCC-HIVE 示例值：TCC-HIVE |
| Status | 否 | Integer | 状态信息：注册中0，待测试1，连接成功2，连接失败3，删除中4，已删除5 示例值：2 |
| Operator | 否 | String | 操作人uin 示例值：3783892123 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TccCatalogSet | Array of TccCatalogSet | 数据目录列表 示例值：复杂类型 |
| Total | Integer | 总数 示例值：10 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取Tcc数据目录列表
获取Tcc数据目录列表
输入示例
POST / HTTP/1.1
Host: tccatalog.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTccCatalogs
<公共请求参数>
{
"CatalogId": "b8sd7dd7-ekd4-4e5e-993e-e5db64fa21c1"
}输出示例
{
"Response": {
"TccCatalogSet": [
{
"Id": "b8sd7dd7-ekd4-4e5e-993e-e5db64fa21c1",
"Name": "TccHiveCatalog",
"Type": "TCC-HIVE",
"Status": 2,
"Operator": "3783892123",
"CreateTime": "2024-01-01 12:00:00",
"UpdateTime": "2024-01-01 12:00:00"
}
],
"Total": 10,
"RequestId": "b8sd7dd7-ekd4-4e5e-993e-e5db64fa21c1"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter.InvalidTimeFormat | 时间格式异常，仅支持：YYYY-mm-dd HH:MM:SS |
| InvalidParameter.InvalidTimeParameter | 无效的时间，结束时间应大于起始时间 |
