ListIndexes_开放搜索-问天引擎_API文档-阿里云OpenAPI开发者门户

接口说明

方法

GET

URI

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

searchengine:ListIndexes	List	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	无	无

请求语法

GET /openapi/ha3/instances/{instanceId}/indexes HTTP/1.1

路径参数

字段名称	字段详情
instanceIdstring	实例 ID。示例值:ha-cn-2r42ost****参考取值来源: ListInstances UpdateInstance CreateInstance CloneSqlInstance ExecuteSqlInstance

请求参数

字段名称	字段详情
newModeboolean	是否为新版本控制台页面。示例值:true
catalogstring	dlf 数据源-数据目录 ID 示例值:clg-paimon-765e9e2d43ab4fccbf095853a661eafc
databasestring	dlf 数据源-数据库示例值:dlf_test参考取值来源: ListDatabases
tablestring	dlf 数据源数据表示例值:rag

请求说明

请求示例

GET /openapi/ha3/instances/ose-test1/indexes

返回参数

字段名称	字段详情
requestIdstring	请求 ID。示例值:4FB0325E-8C37-5525-96AC-0333523170A3
resultarray<object>	索引详情列表。

返回说明

返回示例

正确返回

{

  "requestId": "38b079f1-7846-4226-8c90-3e2644b5c52b",

  "result": [

    {

      "name": "index1",

      "dataSource": "test_yyds_data1",

    },

    {

      "name": "index1",

      "dataSource": "test_yyds_data1",

    }

  ]

}

返回示例

变更历史

	变更时间	变更内容概要	操作
	2024-12-05	变更返回参数
	2023-07-20	新增请求参数newMode 变更返回参数
	2022-09-05	变更请求参数instanceId 变更返回参数
	2022-01-12	新增OpenAPI，获取索引列表

ListIndexes_开放搜索-问天引擎_API文档

接口说明

方法

URI

流控信息

授权信息

请求语法

路径参数

请求参数

请求说明

请求示例

返回参数

返回说明

返回示例

返回示例

变更历史

相关示例