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.
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: DeleteIdlFiles. |
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 IDL resides |
IdlFiles.N | Yes | Array of IdlFileInfo | List of information of IDL files to be deleted |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of returned results |
IdlFileInfos | Array of IdlFileInfoWithoutContent | Deletion result |
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. |
This example shows you how to delete a target IDL file.
POST / HTTP/1.1
Host: tcaplusdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteIdlFiles
<Common request parameters>
{
"ClusterId": "6084038577",
"IdlFiles": [
{
"FileExtType": "proto",
"FileType": "PROTO",
"FileName": "tb_example",
"FileSize": 0,
"FileContent": "xx",
"FileId": 0
}
]
}
{
"Response": {
"IdlFileInfos": [
{
"Error": null,
"FileExtType": "proto",
"FileId": 849,
"FileName": "tb_example",
"FileSize": 266,
"FileType": "PROTO"
}
],
"RequestId": "4e79897b-5696-4d1b-b337-d2b46824de64",
"TotalCount": 1
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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?