調用GetTable API擷取索引表資訊-智能OpenSearch OpenSearch-阿里雲 - 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

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

請求範例

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>	索引結構。
	array<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>	欄位處理設定。
	array<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"
          }
        }
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。