查看索引表版本详情。
接口说明
方法
GETURI
/openapi/ha3/instances/{instanceId}/indexes/{indexName}?dataSource=xxx调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| searchengine:GetIndex | Read |
|
| 无 |
请求语法
GET /openapi/ha3/instances/{instanceId}/indexes/{indexName}
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 实例ID | ha-cn-8ed2j834u03 |
| indexName | string | 是 | 索引名称 | index_jiayi_text |
请求示例
GET /openapi/ha3/instances/ose-test1/indexes/index1?dataSource=xxx返回参数
返回示例
正确返回
{
"requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
"result": {
"name": "index1",
"dataSource": "test_yyds_data1",
"versions": [
{
"name": "my_index_1",
"versionId": 1,
"status": "drafting",
"updateTime": "1631070464000",
"desc": "test",
"files": [
{
"fullPathName": "/",
"isDir": true,
"isTemplate": true,
"name": "cava"
},
{
"fullPathName": "/",
"isDir": true,
"isTemplate": true,
"name": "cava"
}
]
},
{
"name": "my_index_2",
"versionId": 1,
"status": "drafting",
"updateTime": "1631070464000",
"desc": "test",
"files": [
{
"fullPathName": "/",
"isDir": true,
"isTemplate": true,
"name": "cava"
},
{
"fullPathName": "/",
"isDir": true,
"isTemplate": true,
"name": "cava"
}
]
}
]
}
}示例
正常返回示例
JSON格式
{
"requestId": "4FB0325E-8C37-5525-96AC-0333523170A3",
"result": {
"name": "general",
"versions": [
{
"desc": "close alarm, by 3.9.2 hotfix workflow",
"files": [
{
"fullPathName": "\" \"",
"isDir": true,
"isTemplate": true,
"name": ""
}
],
"name": "ha-cn-7pp2ngv4s02_qrs",
"status": "2",
"updateTime": 0,
"versionId": 1
}
],
"dataSource": "ha-cn-tl32nd2nq01_00",
"domain": "",
"indexStatus": "",
"content": "",
"partition": 0,
"fullVersion": 0,
"fullUpdateTime": "",
"incUpdateTime": "",
"indexSize": 0,
"description": "",
"dataSourceInfo": {
"processPartitionCount": 0,
"name": "",
"type": "",
"domain": "",
"config": {
"endpoint": "",
"accessKey": "",
"accessSecret": "",
"project": "",
"partition": "",
"table": "",
"namespace": "",
"path": "",
"ossPath": "",
"bucket": ""
},
"saroConfig": {
"namespace": "",
"tableName": ""
},
"autoBuildIndex": true
}
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||
|---|---|---|---|---|---|---|---|---|
| 2023-07-20 | OpenAPI 入参发生变更，OpenAPI 返回结构发生变更 | |||||||
| ||||||||
| 2022-01-12 | 新增 OpenAPI |