GetIndex - OpenSearch - Alibaba Cloud Documentation Center

Retrieves the details of an index table version.

Operation description

Method

GET

URI

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

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:GetIndex

get

*Instance

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

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-pl32rf0****
indexName	string	Yes	The index name.	test_api

Request examples

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

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	4FB0325E-8C37-5525-96AC-0333523170A3
result	object	The index information.
name	string	The index name.	test_api
versions	array<object>	The version information.
	object	The data version information.
desc	string	The description.	Index Note
files	array<object>	The location.
	object	The version details.
fullPathName	string	The full path.	/qrs.json
isDir	boolean	Indicates whether the path points to a directory.	true
isTemplate	boolean	Indicates whether the path is a template.	true
name	string	The file name.	qrs.json
name	string	The version name.	test
status	string	The status. NEW: Created. PUBLISH: Normal. IN_USE: In use. NOT_USE: Not in use. STOP_USE: Stopping. RESTORE_USE: Resuming. FAIL: Failed.	PUBLISH
updateTime	integer	The time when the version was updated.	1718846192
versionId	integer	The version ID.	1
dataSource	string	The data source.	ha-cn-pl32rf0****_test_api
domain	string	The deployment name of the data source.	sz_vpc_domain_1
indexStatus	string	The status. NEW: Created. PUBLISH: Normal. IN_USE: In use. NOT_USE: Not in use. STOP_USE: Stopping. RESTORE_USE: Resuming. FAIL: Failed.	IN_USE
content	string	The content of the file.	{"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	integer	The data shard.	2
fullVersion	integer	The data version.	1688523414
fullUpdateTime	string	The time of the last full switchover.	2024-06-20 08:52:54
incUpdateTime	string	The time of the last incremental update.	2024-06-20 08:52:54
indexSize	integer	The index size.	4689
description	string	The note.	note
dataSourceInfo	object	The information about the data source.
processPartitionCount	integer	The number of resources for data updates.	2
name	string	The name of the data source.	ha-cn-pl32rf0****_test_api
type	string	The type of the data source. Valid values: odps, swift, saro, oss, and unKnow.	odps
domain	string	The offline deployment.	vpc_hz_domain_1
config	object	The configurations of the ODPS data source.
endpoint	string	Information related to ODPS.	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	The AccessKey ID for the ODPS data source.	L***p
accessSecret	string	The AccessKey secret for the ODPS data source.	5**9a6
project	string	The name of the ODPS project.	tisplus_dev
partition	string	The ODPS partition. Example: ds=20180102	ds=20220713
table	string	Information related to saro and ODPS.	dump_odps_demo
namespace	string	Information related to saro.	TEST_dump_demo_sj_na61hunbu2_share_holo
path	string	Information related to HDFS.	http://test_opensearch/sift_oss_test.data
ossPath	string	Information related to the OSS data source.	/test_opensearch/sift_oss_test.data
bucket	string	The name of the bucket.	ha3test-oss
format	string	The file format of the data in OSS. ha3 json	ha3
catalog	string	The data catalog ID of the DLF data source.	clg-paimon-21cc136237a6457f8618f5f82d116d7e
database	string	The database of the DLF data source.	dlf_test
tag	string	The tag of the DLF data source.	test_tag
saroConfig	object	The configurations of the saro data source.
namespace	string	The namespace of the saro data source.	TEST_dump_demo_sj_na61hunbu2_share_holo
tableName	string	The name of the saro data table.	llm
autoBuildIndex	boolean	Indicates whether automatic full indexing is enabled.	true
processParallelNum	integer	The concurrency for full processing.	2
createTime	string	The time when the index was created.	2024-05-21 16:05:26
updateTime	string	The time when the index was updated.	2024-05-21 16:05:26
cluster	object	The cluster information.
	object	The cluster information.
buildParallelNum	integer	The concurrency for full indexing.	2
mergeParallelNum	integer	The concurrency for full merging.	2
config	object	The configuration information.
	object	The configuration information.
configWhenBuild	object	The configuration that will take effect for the next indexing.
	object	The configuration that will take effect for the next indexing.
extend	object	The extended information.
	array	The extended information.

Response examples

Example of a successful response

{
    "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
    "result": {
        "name": "index-name",
        "dataSource": "ha-cn-xxx-index-name",
        "domain": "test", // The deployment name of the data source
        "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\":\"Note 2\"}",
                "{\"feild3\":\"Note 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": "Description"
            },
            "OFFLINE_TABLE": {
                "name": "ha-cn-finxmo71065_table_ha-cn-finxmo71065_test_saro_v2",
                "updateTime": 1709261682000,
                "desc": "Description"
            },
            "OFFLINE_COMMON": {
                "name": "ha-cn-finxmo71065_offline_adv_v2",
                "updateTime": 1709259817000,
                "desc": "Description"
            },
            "OFFLINE_PLUGIN": {
                "name": "ha-cn-finxmo71065_offline_plugin_v2",
                "updateTime": 1709259817000,
                "desc": "Description"
            },
            "OFFLINE_INDEX": {
                "name": "ha-cn-finxmo71065@ha-cn-finxmo71065_test_saro@test_saro@index_config_v2",
                "updateTime": 1709259817000,
                "desc": "Description"
            }
        },
        "configWhenBuild": {
            "OFFLINE_DICT": {
                "name": "ha-cn-finxmo71065_offline_dict_v2",
                "updateTime": 1709259817000,
                "desc": "Description"
            },
            "OFFLINE_TABLE": {
                "name": "ha-cn-finxmo71065_table_ha-cn-finxmo71065_test_saro_v2",
                "updateTime": 1709261682000,
                "desc": "Description"
            },
            "OFFLINE_COMMON": {
                "name": "ha-cn-finxmo71065_offline_adv_v2",
                "updateTime": 1709259817000,
                "desc": "Description"
            },
            "OFFLINE_PLUGIN": {
                "name": "ha-cn-finxmo71065_offline_plugin_v2",
                "updateTime": 1709259817000,
                "desc": "Description"
            },
            "OFFLINE_INDEX": {
                "name": "ha-cn-finxmo71065@ha-cn-finxmo71065_test_saro@test_saro@index_config_v2",
                "updateTime": 1709259817000,
                "desc": "Description"
            }
        }
    }

Examples

Success response

JSON format

{
  "requestId": "4FB0325E-8C37-5525-96AC-0333523170A3",
  "result": {
    "name": "test_api",
    "versions": [
      {
        "desc": "Index Note",
        "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": "note",
    "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",
        "format": "ha3",
        "catalog": "clg-paimon-21cc136237a6457f8618f5f82d116d7e",
        "database": "dlf_test",
        "tag": "test_tag"
      },
      "saroConfig": {
        "namespace": "TEST_dump_demo_sj_na61hunbu2_share_holo",
        "tableName": "llm"
      },
      "autoBuildIndex": true,
      "processParallelNum": 2
    },
    "createTime": "2024-05-21 16:05:26",
    "updateTime": "2024-05-21 16:05:26",
    "cluster": {
      "key": {
        "buildParallelNum": 2,
        "mergeParallelNum": 2
      }
    },
    "config": {
      "key": {
        "key": {
          "name": "\nha-cn-pl32rf0****_offline_adv_v1",
          "updateTime": "1716258634000",
          "desc": "Note Information"
        }
      }
    },
    "configWhenBuild": {
      "key": {
        "key": {
          "name": "\nha-cn-pl32rf0****_offline_adv_v1",
          "updateTime": "1716258634000",
          "desc": "Note Information"
        }
      }
    },
    "extend": {
      "key": [
        "Extended Information"
      ]
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.