删除索引

最近更新时间:2024-03-12 01:30:26

我的收藏

1. 接口描述

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

删除索引

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DeleteIndex。
Version String 公共参数,本接口取值:2018-04-16。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String ES集群ID
示例值:es-abcdefgh
IndexType String 删除的索引类型。auto:自治索引;normal:普通索引
示例值:auto
IndexName String 删除的索引名
示例值:test
Username String 集群访问用户名
示例值:elastic
Password String 集群访问密码
示例值:123456
BackingIndexName String 后备索引名
示例值:test

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 删除自治索引

删除自治索引

输入示例

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

{
    "Username": "1",
    "IndexName": "1",
    "IndexType": "1",
    "InstanceId": "1",
    "BackingIndexName": "1",
    "Password": "1"
}

输出示例

{
    "Response": {
        "RequestId": "1"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter.InvalidAppId AppId的取值和预期不符。
InvalidParameter.InvalidEsVersion 实例版本EsVersion的取值和预期不符。
InvalidParameter.InvalidIndexType 索引类型IndexType的取值和预期不符。
InvalidParameter.InvalidInstanceId 无效的InstanceId,没有找到对应资源。
ResourceNotFound.ClusterInfoNotFound 集群资源获取失败。
ResourceNotFound.DBInfoNotFound 数据库资源获取失败。