查询表描述文件详情

最近更新时间:2019-11-26 22:11:24

1. 接口描述

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

查询表描述文件详情

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeIdlFileInfos
Version String 公共参数,本接口取值:2019-08-23
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-hongkong, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo, eu-frankfurt, na-siliconvalley
ApplicationId String 文件所属应用实例ID
LogicZoneIds.N Array of String 文件所属大区ID
IdlFileIds.N Array of String 指定文件ID
Offset Integer 偏移量
Limit Integer 文件列表大小

3. 输出参数

参数名称 类型 描述
TotalCount Integer 文件数量
IdlFileInfos Array of IdlFileInfo 文件详情列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询描述文件详情

指定应用实例ID查询描述文件列表

输入示例

https://tcaplus.tencentcloudapi.com/?Action=DescribeIdlFileInfos
&ApplicationId=5674209986
&<公共请求参数>

输出示例

{
  "Response": {
    "IdlFileInfos": [
      {
        "FileContent": null,
        "FileExtType": "proto",
        "FileId": 600,
        "FileName": "tb_example_modify",
        "FileSize": 292,
        "FileType": "PROTO"
      },
      {
        "FileContent": null,
        "FileExtType": "proto",
        "FileId": 548,
        "FileName": "tb_example",
        "FileSize": 298,
        "FileType": "PROTO"
      },
      {
        "FileContent": null,
        "FileExtType": "proto",
        "FileId": 549,
        "FileName": "tb_example",
        "FileSize": 298,
        "FileType": "PROTO"
      },
      {
        "FileContent": null,
        "FileExtType": "proto",
        "FileId": 550,
        "FileName": "tb_example",
        "FileSize": 266,
        "FileType": "PROTO"
      },
      {
        "FileContent": null,
        "FileExtType": "proto",
        "FileId": 551,
        "FileName": "tb_example",
        "FileSize": 266,
        "FileType": "PROTO"
      },
      {
        "FileContent": null,
        "FileExtType": "proto",
        "FileId": 552,
        "FileName": "tb_example",
        "FileSize": 266,
        "FileType": "PROTO"
      },
      {
        "FileContent": null,
        "FileExtType": "proto",
        "FileId": 553,
        "FileName": "tb_example",
        "FileSize": 266,
        "FileType": "PROTO"
      },
      {
        "FileContent": null,
        "FileExtType": "proto",
        "FileId": 559,
        "FileName": "tb_example",
        "FileSize": 266,
        "FileType": "PROTO"
      },
      {
        "FileContent": null,
        "FileExtType": "proto",
        "FileId": 560,
        "FileName": "tb_example",
        "FileSize": 266,
        "FileType": "PROTO"
      },
      {
        "FileContent": null,
        "FileExtType": "proto",
        "FileId": 561,
        "FileName": "tb_example",
        "FileSize": 266,
        "FileType": "PROTO"
      },
      {
        "FileContent": null,
        "FileExtType": "proto",
        "FileId": 562,
        "FileName": "tb_example",
        "FileSize": 267,
        "FileType": "PROTO"
      },
      {
        "FileContent": null,
        "FileExtType": "proto",
        "FileId": 563,
        "FileName": "tb_example",
        "FileSize": 380,
        "FileType": "PROTO"
      },
      {
        "FileContent": null,
        "FileExtType": "proto",
        "FileId": 564,
        "FileName": "tb_example",
        "FileSize": 266,
        "FileType": "PROTO"
      }
    ],
    "RequestId": "1b6a5d3f-beb3-4380-9b6d-3d9f2d83654c",
    "TotalCount": 13
  }
}

示例2 指定应用id和文件id查询文件详情

指定应用id和文件id查询文件详情

输入示例

https://tcaplus.tencentcloudapi.com/?Action=DescribeIdlFileInfos
&ApplicationId=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 Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound 资源不存在。