Queries the information about an index table.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request syntax
GET /openapi/ha3/instances/{instanceId}/tables/{tableName}
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
instanceId | string | Yes | The instance ID. | ha-cn-0ju2k3qer02 |
Response parameters
Examples
Sample success responses
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": "{\n \"id\": \"INT64\",\n \"source_image\": \"STRING\",\n \"namespace\": \"INT64\",\n \"source_image_vector\": \"MULTI_FLOAT\"\n }\n"
},
"vectorIndex": [
{
"indexName": "test_odps",
"vectorField": "source_image_vector",
"sparseIndexField": "sparse_indices",
"sparseValueField": "sparse_values",
"dimension": "128",
"vectorIndexType": "Qc",
"distanceType": "SquaredEuclidean",
"namespace": "namespace",
"advanceParams": {
"buildIndexParams": "{}",
"searchIndexParams": "{}",
"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
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-05-09 | The response structure of the API has changed | View Change Details |