全部产品
Search

搜索本产品

    智能开放搜索 OpenSearch：DeleteIndex - 删除索引

    文档中心

    智能开放搜索 OpenSearch：DeleteIndex - 删除索引

    更新时间：Oct 16, 2024

    删除索引。

    接口说明

    方法

    DELETE

    URI

    /openapi/ha3/instances/{instanceId}/indexes/{indexName}

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    searchengine:DeleteIndex
    • Instance
      acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}
      无
    		无

    请求语法

    DELETE /openapi/ha3/instances/{instanceId}/indexes/{indexName} HTTP/1.1

    请求参数

    名称类型必填描述示例值
    instanceIdstring是

    实例 ID

    		ha-cn-pl32rf0****
    indexNamestring是

    索引名称

    		test_api
    dataSourcestring是

    数据源

    		ha-cn-pl32rf0****_ test_api
    deleteDataSourceboolean否

    是否删除数据源

    		true

    请求示例

    

    DELETE /openapi/ha3/instances/ose-test1/indexes/my_index?dataSource=xxx

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    requestIdstring

    请求 ID。

    		022F36C7-9FB4-5D67-BEBC-3D14B0984463
    resultobject

    返回结果。

    		{}

    返回示例

    正确返回 

    {

  "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",

  "result": []

}

    详情可参考响应结构

    示例

    正常返回示例

    JSON格式

    {
  "requestId": "022F36C7-9FB4-5D67-BEBC-3D14B0984463",
  "result": {}
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2023-07-20OpenAPI 入参发生变更查看变更详情
    2022-01-12新增 OpenAPI查看变更详情