全部产品
Search
文档中心

智能开放搜索 OpenSearch:GetIndex - 查看索引表详情

更新时间:Oct 16, 2024

查看索引表版本详情。

接口说明

方法

GET

URI

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

调试

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

授权信息

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

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

请求语法

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

请求参数

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

实例 ID

ha-cn-pl32rf0****
indexNamestring

索引名称

test_api

请求示例

GET  /openapi/ha3/instances/ose-test1/indexes/index1?dataSource=xxx

返回参数

名称类型描述示例值
object
requestIdstring

请求 ID。

4FB0325E-8C37-5525-96AC-0333523170A3
resultobject

索引信息

namestring

索引名称

test_api
versionsarray<object>

版本信息

versionsobject

数据版本信息

descstring

描述信息

索引备注
filesarray<object>

所在位置

filesobject

版本详情

fullPathNamestring

完整路径

/qrs.json
isDirboolean

是文件夹

true
isTemplateboolean

是模板

true
namestring

文件名称

qrs.json
namestring

版本名称

test
statusstring

状态

  • NEW:创建。
  • PUBLISH:正常。
  • IN_USE:使用中。
  • NOT_USE:未使用。
  • STOP_USE:停止使用中。
  • RESTORE_USE:恢复使用中。
  • FAIL:失败。
PUBLISH
updateTimelong

更新时间

1718846192
versionIdinteger

版本 ID

1
dataSourcestring

数据源

ha-cn-pl32rf0****_test_api
domainstring

数据源的部署名

sz_vpc_domain_1
indexStatusstring

状态

  • NEW:创建。
  • PUBLISH:正常。
  • IN_USE:使用中。
  • NOT_USE:未使用。
  • STOP_USE:停止使用中。
  • RESTORE_USE:恢复使用中。
  • FAIL:失败。
IN_USE
contentstring

文件内容

{"summarys":{"parameter":{"file_compressor":"zstd"},"summary_fields":["id"]},"file_compress":[{"name":"file_compressor","type":"zstd"},{"name":"no_compressor","type":""}],"indexs":[{"index_fields":"name","index_name":"ids","index_type":"STRING"},{"has_primary_key_attribute":true,"index_fields":"id","is_primary_key_sorted":false,"index_name":"id","index_type":"PRIMARYKEY64"}],"attributes":[{"file_compress":"no_compressor","field_name":"id"}],"fields":[{"user_defined_param":{},"compress_type":"uniq","field_type":"STRING","field_name":"id"},{"compress_type":"uniq","field_type":"STRING","field_name":"name"}],"table_name":"api"}
partitioninteger

数据分片

2
fullVersionlong

数据版本

1688523414
fullUpdateTimestring

全量切换时间

2024-06-20 08:52:54
incUpdateTimestring

增量更新时间

2024-06-20 08:52:54
indexSizelong

索引大小

4689
descriptionstring

备注

备注
dataSourceInfoobject

数据源相关信息

processPartitionCountinteger

数据更新资源数

2
namestring

数据源名

ha-cn-pl32rf0****_test_api
typestring

数据源类型 (odps, swift, saro, oss, unKnow)

odps
domainstring

离线部署

vpc_hz_domain_1
configobject

odps 数据源配置

endpointstring

odps 相关

http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKeystring

odps 数据源 ak

L***p
accessSecretstring

odps 数据源 ak secret

5**9a6
projectstring

odps 数据源项目名称

tisplus_dev
partitionstring

ODPS Partition。例如:ds=20180102

ds=20220713
tablestring

saro、odps 相关

dump_odps_demo
namespacestring

saro 相关

TEST_dump_demo_sj_na61hunbu2_share_holo
pathstring

hdfs 相关

http://test_opensearch/sift_oss_test.data
ossPathstring

oss 数据源相关

/test_opensearch/sift_oss_test.data
bucketstring

Bucket 名称。

ha3test-oss
saroConfigobject

saro 数据源配置

namespacestring

saro 数据源的 namespace

TEST_dump_demo_sj_na61hunbu2_share_holo
tableNamestring

saro 数据表名称

llm
autoBuildIndexboolean

是否开启自动全量

true
processParallelNuminteger

全量 process 并发数

2
clusterobject

集群信息

object

集群信息

buildParallelNuminteger

全量并发数

2
mergeParallelNuminteger

全量 merge 并发数

2
configobject

配置信息

object

配置信息

object

子配置项信息

namestring

配置名称

ha-cn-pl32rf0****_offline_adv_v1
updateTimestring

更新时间

1716258634000
descstring

高级配置描述信息

备注信息
configWhenBuildobject

下次生效的配置

object

下次生效的配置

object

下次生效的子配置

namestring

配置名称

ha-cn-pl32rf0****_offline_adv_v1
updateTimestring

更新时间

1716258634000
descstring

高级配置描述信息

备注信息
extendobject

扩展信息

array

扩展信息

extendstring

扩展信息

扩展信息

返回示例

正确返回

{
    "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
    "result": {
        "name": "index-name",
        "dataSource": "ha-cn-xxx-index-name",
        "domain": "test", // 数据源的部署名称
        "partition": 2,
        "indexStatus": "IN_USE",
        "content": "{\n\t\"summarys\":{\n\t\t\"parameter\":{\n\t\t\t\"file_compressor\":\"zstd\"\n\t\t},\n\t\t\"summary_fields\":[\n\t\t\t\"id\"\n\t\t]\n\t},\n\t\"file_compress\":[\n\t\t{\n\t\t\t\"name\":\"file_compressor\",\n\t\t\t\"type\":\"zstd\"\n\t\t},\n\t\t{\n\t\t\t\"name\":\"no_compressor\",\n\t\t\t\"type\":\"\"\n\t\t}\n\t],\n\t\"indexs\":[\n\t\t{\n\t\t\t\"index_fields\":\"name\",\n\t\t\t\"index_name\":\"ids\",\n\t\t\t\"index_type\":\"STRING\"\n\t\t},\n\t\t{\n\t\t\t\"has_primary_key_attribute\":true,\n\t\t\t\"index_fields\":\"id\",\n\t\t\t\"is_primary_key_sorted\":false,\n\t\t\t\"index_name\":\"id\",\n\t\t\t\"index_type\":\"PRIMARYKEY64\"\n\t\t}\n\t],\n\t\"attributes\":[\n\t\t{\n\t\t\t\"file_compress\":\"no_compressor\",\n\t\t\t\"field_name\":\"id\"\n\t\t}\n\t],\n\t\"fields\":[\n\t\t{\n\t\t\t\"user_defined_param\":{},\n\t\t\t\"compress_type\":\"uniq\",\n\t\t\t\"field_type\":\"STRING\",\n\t\t\t\"field_name\":\"id\"\n\t\t},\n\t\t{\n\t\t\t\"compress_type\":\"uniq\",\n\t\t\t\"field_type\":\"STRING\",\n\t\t\t\"field_name\":\"name\"\n\t\t}\n\t],\n\t\"table_name\":\"api\"\n}",
        "extend": {
            "vector": [
                "vector"
            ],
            "embeding": [
                "id"
            ],
            "description": [
                "{\"feild2\":\"备注 2\"}",
                "{\"feild3\":\"备注 3\"}"
            ]
        },
        "cluster": {
            "build_parallel_num": "2",
            "merge_parallel_num": "2"
        },
        "dataSourceInfo": {
            "type": "odps",
            "dataSource": "ha-cn-xxx-index-name",
            "processPartitionCount": 2,
            "domain": "test",
            "autoBuildIndex": true,
            "config": {
                "project": "tisplus_dev",
                "table": "tisplus_one_key_build_station_template_table_test",
                "partition": "ds=12345",
                "accesskeyId": "root",
                "accesskeySecret": "root123",
                "endpoint": "http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api"
            },
            "saroConfig": {
                "namespace": "TEST_dump_demo_sj_na61hunbu2_share_holo",
                "tableName": "dump_odps_demo"
            },
            "processParallelNum": 2,
           "swiftConfig":{
              "topic":"ha-cn-xxx-index-name"
            }
        },
        "config": {
            "OFFLINE_DICT": {
                "name": "ha-cn-finxmo71065_offline_dict_v2",
                "updateTime": 1709259817000,
                "desc": "描述"
            },
            "OFFLINE_TABLE": {
                "name": "ha-cn-finxmo71065_table_ha-cn-finxmo71065_test_saro_v2",
                "updateTime": 1709261682000,
                "desc": "描述"
            },
            "OFFLINE_COMMON": {
                "name": "ha-cn-finxmo71065_offline_adv_v2",
                "updateTime": 1709259817000,
                "desc": "描述"
            },
            "OFFLINE_PLUGIN": {
                "name": "ha-cn-finxmo71065_offline_plugin_v2",
                "updateTime": 1709259817000,
                "desc": "描述"
            },
            "OFFLINE_INDEX": {
                "name": "ha-cn-finxmo71065@ha-cn-finxmo71065_test_saro@test_saro@index_config_v2",
                "updateTime": 1709259817000,
                "desc": "描述"
            }
        },
        "configWhenBuild": {
            "OFFLINE_DICT": {
                "name": "ha-cn-finxmo71065_offline_dict_v2",
                "updateTime": 1709259817000,
                "desc": "描述"
            },
            "OFFLINE_TABLE": {
                "name": "ha-cn-finxmo71065_table_ha-cn-finxmo71065_test_saro_v2",
                "updateTime": 1709261682000,
                "desc": "描述"
            },
            "OFFLINE_COMMON": {
                "name": "ha-cn-finxmo71065_offline_adv_v2",
                "updateTime": 1709259817000,
                "desc": "描述"
            },
            "OFFLINE_PLUGIN": {
                "name": "ha-cn-finxmo71065_offline_plugin_v2",
                "updateTime": 1709259817000,
                "desc": "描述"
            },
            "OFFLINE_INDEX": {
                "name": "ha-cn-finxmo71065@ha-cn-finxmo71065_test_saro@test_saro@index_config_v2",
                "updateTime": 1709259817000,
                "desc": "描述"
            }
        }
    }

示例

正常返回示例

JSON格式

{
  "requestId": "4FB0325E-8C37-5525-96AC-0333523170A3",
  "result": {
    "name": "test_api",
    "versions": [
      {
        "desc": "索引备注",
        "files": [
          {
            "fullPathName": "/qrs.json\n",
            "isDir": true,
            "isTemplate": true,
            "name": "qrs.json"
          }
        ],
        "name": "test",
        "status": "PUBLISH",
        "updateTime": 1718846192,
        "versionId": 1
      }
    ],
    "dataSource": "ha-cn-pl32rf0****_test_api\n",
    "domain": "sz_vpc_domain_1",
    "indexStatus": "IN_USE",
    "content": "{\"summarys\":{\"parameter\":{\"file_compressor\":\"zstd\"},\"summary_fields\":[\"id\"]},\"file_compress\":[{\"name\":\"file_compressor\",\"type\":\"zstd\"},{\"name\":\"no_compressor\",\"type\":\"\"}],\"indexs\":[{\"index_fields\":\"name\",\"index_name\":\"ids\",\"index_type\":\"STRING\"},{\"has_primary_key_attribute\":true,\"index_fields\":\"id\",\"is_primary_key_sorted\":false,\"index_name\":\"id\",\"index_type\":\"PRIMARYKEY64\"}],\"attributes\":[{\"file_compress\":\"no_compressor\",\"field_name\":\"id\"}],\"fields\":[{\"user_defined_param\":{},\"compress_type\":\"uniq\",\"field_type\":\"STRING\",\"field_name\":\"id\"},{\"compress_type\":\"uniq\",\"field_type\":\"STRING\",\"field_name\":\"name\"}],\"table_name\":\"api\"}",
    "partition": 2,
    "fullVersion": 1688523414,
    "fullUpdateTime": "2024-06-20 08:52:54",
    "incUpdateTime": "2024-06-20 08:52:54",
    "indexSize": 4689,
    "description": "备注",
    "dataSourceInfo": {
      "processPartitionCount": 2,
      "name": "ha-cn-pl32rf0****_test_api\n",
      "type": "odps",
      "domain": "vpc_hz_domain_1",
      "config": {
        "endpoint": "http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api",
        "accessKey": "L***p",
        "accessSecret": "5**9a6",
        "project": "tisplus_dev",
        "partition": "ds=20220713",
        "table": "dump_odps_demo",
        "namespace": "TEST_dump_demo_sj_na61hunbu2_share_holo",
        "path": "http://test_opensearch/sift_oss_test.data",
        "ossPath": "/test_opensearch/sift_oss_test.data",
        "bucket": "ha3test-oss",
        "catalog": "",
        "database": "",
        "tag": ""
      },
      "saroConfig": {
        "namespace": "TEST_dump_demo_sj_na61hunbu2_share_holo",
        "tableName": "llm"
      },
      "autoBuildIndex": true,
      "processParallelNum": 2
    },
    "cluster": {
      "key": {
        "buildParallelNum": 2,
        "mergeParallelNum": 2
      }
    },
    "config": {
      "key": {
        "key": {
          "name": "\nha-cn-pl32rf0****_offline_adv_v1",
          "updateTime": "1716258634000",
          "desc": "备注信息"
        }
      }
    },
    "configWhenBuild": {
      "key": {
        "key": {
          "name": "\nha-cn-pl32rf0****_offline_adv_v1",
          "updateTime": "1716258634000",
          "desc": "备注信息"
        }
      }
    },
    "extend": {
      "key": [
        "扩展信息"
      ]
    }
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-07-31OpenAPI 返回结构发生变更查看变更详情
2024-05-16OpenAPI 返回结构发生变更查看变更详情
2023-07-20OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2022-01-12新增 OpenAPI查看变更详情