1. 接口描述
接口请求域名： tcaplusdb.tencentcloudapi.com 。
查询表描述文件详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeIdlFileInfos。 |
| Version | 是 | String | 公共参数，本接口取值：2019-08-23。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ClusterId | 是 | String | 文件所属集群ID 示例值：1876767 |
| TableGroupIds.N | 否 | Array of String | 文件所属表格组ID 示例值：1214765 |
| IdlFileIds.N | 否 | Array of String | 指定文件ID列表 示例值：testfield |
| Offset | 否 | Integer | 查询列表偏移量 示例值：0 |
| Limit | 否 | Integer | 查询列表返回记录数 示例值：10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 文件数量 示例值：10 |
| IdlFileInfos | Array of IdlFileInfo | 文件详情列表 示例值：{} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询描述文件详情
指定集群ID查询描述文件列表
输入示例
https://tcaplus.tencentcloudapi.com/?Action=DescribeIdlFileInfos
&ClusterId=5674209986
&<公共请求参数>输出示例
{
"Response": {
"TotalCount": 1,
"IdlFileInfos": [
{
"FileName": "filename",
"FileType": "tdr",
"FileExtType": "tdr",
"FileSize": 1321230,
"FileId": 1,
"FileContent": "content"
}
],
"RequestId": "1898921-12142"
}
}示例2 指定集群ID和文件ID查询文件详情
指定集群ID和文件ID查询文件详情
输入示例
https://tcaplus.tencentcloudapi.com/?Action=DescribeIdlFileInfos
&ClusterId=5674209986
&IdlFileIds.0=564
&<公共请求参数>输出示例
{
"Response": {
"IdlFileInfos": [
{
"FileContent": "syntax%3D%22proto2%22%3Bpackage%20myTcaplusTable%3Bimport%20%22tcaplusservice.optionv1.proto%22%3Bmessage%20tb_example%7Boption%28tcaplusservice.tcaplus_primary_key%29%3D%22uin%2Cname%22%3Brequired%20int64%20uin%20%3D%201%3Brequired%20string%20name%20%3D%202%3Brequired%20int32%20gamesvrid%20%3D%203%3Boptional%20string%20logintime%20%3D%204%3B%7D",
"FileExtType": "proto",
"FileId": 564,
"FileName": "tb_example",
"FileSize": 266,
"FileType": "PROTO"
}
],
"RequestId": "5d592aa1-ee73-4b5e-90bf-062efcc05966",
"TotalCount": 1
}
}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 | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound | 资源不存在。 |
