tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TencentDB for TcaplusDB
    Documentation
    Download PDF

    DescribeIdlFileInfos

    Last updated: 2024-07-24 10:20:19
    Download PDF

      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.

      We recommend you to use API Explorer
      Try it
      API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

      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 Params. The value used for this API: DescribeIdlFileInfos.
      Version Yes String Common Params. The value used for this API: 2019-08-23.
      Region Yes String Common Params. For more information, please see the list of regions supported by the product.
      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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

      4. Example

      Example1 Querying description file details

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

      Input Example

      POST / HTTP/1.1
Host: tcaplusdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIdlFileInfos
<Common request parameters>

{
    "TableGroupIds": [
        "xx"
    ],
    "ClusterId": "5674209986",
    "Limit": 0,
    "IdlFileIds": [
        "xx"
    ],
    "Offset": 0
}

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

      Example2 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

      POST / HTTP/1.1
Host: tcaplusdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIdlFileInfos
<Common request parameters>

{
    "TableGroupIds": [
        "xx"
    ],
    "ClusterId": "5674209986",
    "Limit": 0,
    "IdlFileIds": [
        "564"
    ],
    "Offset": 0
}

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

      5. Developer Resources

      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
      FailedOperation Operation failed.
      InternalError Internal error.
      InvalidParameterValue Incorrect parameter value.
      ResourceNotFound The resource does not exist.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy