DescribeIdlFileInfos

Last updated: 2020-05-09 14:20:50

1. API Description

Domain name for API request: tcaplusdb.tencentcloudapi.com.

This API is used to query table description file details.

A maximum of 20 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeIdlFileInfos.
Version Yes String Common parameter. The value used for this API: 2019-08-23.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product. This API only supports: ap-hongkong, ap-seoul, ap-shanghai, ap-singapore, ap-taipei, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley
ClusterId Yes String ID of the cluster where a file resides
TableGroupIds.N No Array of String ID of the table group where a file resides
IdlFileIds.N No Array of String File ID list
Offset No Integer Query list offset
Limit No Integer Number of returned results in query list

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of files
IdlFileInfos Array of IdlFileInfo List of file details
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying file details by specifying cluster ID and file ID

This example shows you how to query file details by specifying the cluster ID and file ID.

Input Example

https://tcaplus.tencentcloudapi.com/?Action=DescribeIdlFileInfos
&ClusterId=5674209986
&IdlFileIds.0=564
&<Common request parameters>

Output Example

{
  "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
  }
}

Example2 Querying description file details

This example shows you how to query the description file list by specifying a cluster ID.

Input Example

https://tcaplus.tencentcloudapi.com/?Action=DescribeIdlFileInfos
&ClusterId=5674209986
&<Common request parameters>

Output Example

{
  "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
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameterValue Incorrect parameter value.
ResourceNotFound The resource does not exist.