Call GetTable API to Query Index Table Details - OpenSearch

Retrieves information about an index table.

Operation description

Method

GET

URI

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

searchengine:GetTable

get

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-pl32rf0****
tableName	string	Yes	The name of the index table.	test_summary

Example request

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

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	2AE63638-5420-56DC-BF59-37D8174039A0
result	object	The returned result.
name	string	The index name.	test_oss
status	string	The status of the index table. Valid values: NEW, PUBLISH, IN_USE (The normal status after an index is successfully created for a Retrieval Engine Edition instance), NOT_USE, STOP_USE, RESTORE_USE, and FAIL (The status when an index fails to be created for the first time in a new version of a Vector Search Edition instance).	IN_USE
dataProcessorCount	integer	The number of data update resources.	1
partitionCount	integer	The number of data shards.	1
dataSource	object	The data source configuration.
type	string	The type of the data source. Valid values: odps, swift, saro, oss, and unKnow. Only odps, swift, and oss are supported.	odps
dataTimeSec	integer	The UNIX timestamp for incremental data.	1715160176
autoBuildIndex	boolean	Indicates whether to automatically rebuild the index.	true
config	object	The data source configuration.
endpoint	string	The ODPS endpoint.	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	The AccessKey ID.	ak
accessSecret	string	The AccessKey secret.	as
project	string	The name of the ODPS data source project.	dp_pdm_marketing_prod
partition	string	The partition information.	ds=20220808
table	string	The name of the saro or ODPS data source table.	test_add
namespace	string	The saro namespace.	namespace
path	string	The HDFS path.	vendor/sebastian/comparator/src/exceptions
ossPath	string	The path of the OSS file.	/opensearch_index_data/sift_oss_test.data
bucket	string	The OSS bucket.	heytea-ops-oss
rawSchema	string	The raw schema. If this parameter is specified, its value is used as the HA3 schema structure, and the system does not assemble a schema.	{}
primaryKey	string	The primary key field.	id
fieldSchema	object	A map of fields. The key is the field name, and the value is the field type.
	string	Identifier	INT64
vectorIndex	array<object>	The index schema.
	object
indexName	string	The name of the index schema.	test_odps
vectorField	string	The vector field.	source_image_vector
sparseIndexField	string	The index field for the sparse vector.	sparse_indices
sparseValueField	string	The value field for the sparse vector.	sparse_values
dimension	string	The vector dimensions.	128
vectorIndexType	string	The vector index algorithm.	Qc
distanceType	string	The distance type.	SquaredEuclidean
namespace	string	The namespace field.	namespace
advanceParams	object	The index schema configuration.
buildIndexParams	string	The index building parameters.	{ "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	The index retrieval parameters.	{"proxima.qc.searcher.scan_ratio":0.01}
minScanDocCnt	string	The minimum number of documents in the retrieval candidate set.	20000
linearBuildThreshold	string	The threshold for linear building.	5000
dataProcessConfig	array<object>	The field processing configuration.
	object	The field processing configuration.
operator	string	The field processing method. Valid values: copy (copies the source field to the destination field) and vectorize (vectorizes the source field using a model and stores the vector in the destination field).	vectorize
dstField	string	The destination field.	source_image_vector
srcField	string	The source field.	source_image
params	object	The model configuration.
vectorModel	string	The vectorization model.	clip
vectorModal	string	The data type.	image
srcFieldConfig	object	The source of the vectorization information.
ossEndpoint	string	The OSS region endpoint.	oss-cn-hangzhou-internal.aliyuncs.com
ossBucket	string	The OSS bucket.	test
uid	string	The ID of the Alibaba Cloud account.	uid

Examples

Success response

JSON format

{
  "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"
          }
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.