删除IDL描述文件

最近更新时间:2021-03-16 08:08:36

我的收藏

1. 接口描述

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

指定集群ID和待删除IDL文件的信息,删除目标文件,如果文件正在被表关联则删除失败。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DeleteIdlFiles。
Version String 公共参数,本接口取值:2019-08-23。
Region String 公共参数,详见产品支持的 地域列表
ClusterId String IDL所属集群ID
IdlFiles.N Array of IdlFileInfo 待删除的IDL文件信息列表

3. 输出参数

参数名称 类型 描述
TotalCount Integer 结果记录数量
IdlFileInfos Array of IdlFileInfoWithoutContent 删除结果
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 删除目标idl文件

删除目标idl文件

输入示例

POST / HTTP/1.1
Host: tcaplusdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteIdlFiles
<公共请求参数>

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceInUse 资源被占用。
ResourceNotFound 资源不存在。
目录