GetTable - 获取索引表信息 - 智能开放搜索 OpenSearch

获取索引表信息。

接口说明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/tables/{tableName}

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
searchengine:GetTable	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	无	无

请求语法

GET /openapi/ha3/instances/{instanceId}/tables/{tableName} HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID	ha-cn-pl32rf0****
tableName	string	是	索引表名称	test_summary

请求示例

GET /openapi/ha3/instances/{instanceId}/tables/{tableName}

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 ID。	2AE63638-5420-56DC-BF59-37D8174039A0
result	object	返回结果
name	string	索引名	test_oss
status	string	索引表状态 (NEW, PUBLISH, IN_USE: 召回引擎版创建成功后为正常状态, NOT_USE, STOP_USE, RESTORE_USE, FAIL: 向量检索版新版本首次创建索引失败状态)	IN_USE
dataProcessorCount	integer	数据更新资源数	1
partitionCount	integer	数据分片数	1
dataSource	object	数据源配置
type	string	数据源类型: 仅支持 odps、swift、oss 三种类型 (odps, swift, saro, oss, unKnow)	odps
dataTimeSec	integer	追增量时间戳	1715160176
autoBuildIndex	boolean	是否自动索引重建	true
config	object	数据源配置
endpoint	string	odps 相关	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	AK	ak
accessSecret	string	AS	as
project	string	odps 数据源项目名称	dp_pdm_marketing_prod
partition	string	分区信息	ds=20220808
table	string	saro、odps 数据源表名	test_add
namespace	string	saro 相关	namespace
path	string	hdfs 相关	vendor/sebastian/comparator/src/exceptions
ossPath	string	oss 文件路径	/opensearch_index_data/sift_oss_test.data
bucket	string	oss 命名空间	heytea-ops-oss
rawSchema	string	如果用户传了 rawSchema，则直接使用 rawSchema 作为 ha3 schema 结构，不用手动拼装	{}
primaryKey	string	主键字段	id
fieldSchema	object	字段 map 集合, key: 字段名 value: 字段类型
	string	id	INT64
vectorIndex	array<object>	索引结构
vectorIndex	object
indexName	string	索引结构名称	test_odps
vectorField	string	向量字段	source_image_vector
sparseIndexField	string	稀疏向量下标字段	sparse_indices
sparseValueField	string	稀疏向量值字段	sparse_values
dimension	string	向量维度	128
vectorIndexType	string	向量索引算法	Qc
distanceType	string	距离类型	SquaredEuclidean
namespace	string	命名空间字段	namespace
advanceParams	object	索引结构配置
buildIndexParams	string	索引构建参数	{ "proxima.qc.builder.quantizer_class": "Int8QuantizerConverter", "proxima.qc.builder.quantize_by_centroid": true, "proxima.qc.builder.optimizer_class": "BruteForceBuilder", "proxima.qc.builder.thread_count": 10, "proxima.qc.builder.optimizer_params": { "proxima.linear.builder.column_major_order": true }, "proxima.qc.builder.store_original_features": false, "proxima.qc.builder.train_sample_count": 3000000, "proxima.qc.builder.train_sample_ratio": 0.5 }
searchIndexParams	string	索引检索参数	{"proxima.qc.searcher.scan_ratio":0.01}
minScanDocCnt	string	召回候选集的个数最小值	20000
linearBuildThreshold	string	线性构建的阈值	5000
dataProcessConfig	array<object>	字段处理配置
dataProcessConfig	object	字段处理配置
operator	string	字段处理方式 (copy: 将源字段拷贝至目标字段, vectorize: 使用模型对源字段进行向量化，向量存储在目标字段中)	vectorize
dstField	string	目标字段	source_image_vector
srcField	string	源字段	source_image
params	object	配置模型信息
vectorModel	string	向量化模型	clip
vectorModal	string	数据类型	image
srcFieldConfig	object	向量化信息来源
ossEndpoint	string	OSS 区域地址。	oss-cn-hangzhou-internal.aliyuncs.com
ossBucket	string	OSS Bucket	test
uid	string	云账号 id	uid

示例

正常返回示例

JSON格式

{
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": {
    "name": "test_oss",
    "status": "IN_USE",
    "dataProcessorCount": 1,
    "partitionCount": 1,
    "dataSource": {
      "type": "odps",
      "dataTimeSec": 1715160176,
      "autoBuildIndex": true,
      "config": {
        "endpoint": "http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api",
        "accessKey": "ak",
        "accessSecret": "as",
        "project": "dp_pdm_marketing_prod",
        "partition": "ds=20220808",
        "table": "test_add",
        "namespace": "namespace",
        "path": "vendor/sebastian/comparator/src/exceptions",
        "ossPath": "/opensearch_index_data/sift_oss_test.data",
        "bucket": "heytea-ops-oss"
      }
    },
    "rawSchema": "{}",
    "primaryKey": "id",
    "fieldSchema": {
      "key": "INT64"
    },
    "vectorIndex": [
      {
        "indexName": "test_odps",
        "vectorField": "source_image_vector",
        "sparseIndexField": "sparse_indices",
        "sparseValueField": "sparse_values",
        "dimension": "128",
        "vectorIndexType": "Qc",
        "distanceType": "SquaredEuclidean",
        "namespace": "namespace",
        "advanceParams": {
          "buildIndexParams": "{\n  \"proxima.qc.builder.quantizer_class\": \"Int8QuantizerConverter\",\n  \"proxima.qc.builder.quantize_by_centroid\": true,\n  \"proxima.qc.builder.optimizer_class\": \"BruteForceBuilder\",\n  \"proxima.qc.builder.thread_count\": 10,\n  \"proxima.qc.builder.optimizer_params\": {\n    \"proxima.linear.builder.column_major_order\": true\n  },\n  \"proxima.qc.builder.store_original_features\": false,\n  \"proxima.qc.builder.train_sample_count\": 3000000,\n  \"proxima.qc.builder.train_sample_ratio\": 0.5\n}",
          "searchIndexParams": "{\"proxima.qc.searcher.scan_ratio\":0.01}",
          "minScanDocCnt": "20000",
          "linearBuildThreshold": "5000"
        }
      }
    ],
    "dataProcessConfig": [
      {
        "operator": "vectorize",
        "dstField": "source_image_vector",
        "srcField": "source_image",
        "params": {
          "vectorModel": "clip",
          "vectorModal": "image",
          "srcFieldConfig": {
            "ossEndpoint": "oss-cn-hangzhou-internal.aliyuncs.com\n",
            "ossBucket": "test",
            "uid": "uid"
          }
        }
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-05-09	OpenAPI 返回结构发生变更	查看变更详情