DeleteIdlFiles

Last updated: 2020-07-24 14:33:51

1. API Description

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

This API is used to delete a target IDL file by specifying the cluster ID and information of the file to be deleted. If the file is associated with a table, deletion will fail.

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 parameter. The value used for this API: DeleteIdlFiles.
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 IDL resides
IdlFiles.N Yes Array of IdlFileInfo List of information of IDL files to be deleted

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of returned results
IdlFileInfos Array of IdlFileInfoWithoutContent Deletion result
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Deleting target IDL file

This example shows you how to delete a target IDL file.

Input Example

https://tcaplus.tencentcloudapi.com/?Action=DeleteIdlFiles
&ClusterId=6084038577
&IdlFiles.0.FileName=tb_example
&IdlFiles.0.FileType=PROTO
&IdlFiles.0.FileExtType=proto
&IdlFiles.0.FileSize=266
&IdlFiles.0.FileId=849
&<common request parameters>

Output Example

{
  "Response": {
    "IdlFileInfos": [
      {
        "Error": null,
        "FileExtType": "proto",
        "FileId": 849,
        "FileName": "tb_example",
        "FileSize": 266,
        "FileType": "PROTO"
      }
    ],
    "RequestId": "4e79897b-5696-4d1b-b337-d2b46824de64",
    "TotalCount": 1
  }
}

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
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
ResourceInUse The resource is in use.
ResourceNotFound The resource does not exist.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help