GetIndex - OpenSearch - Alibaba Cloud Documentation Center

Queries the information about an index version.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-8ed2j834u03
indexName	string	Yes	The index name.	index_jiayi_text

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The ID of the request.	4FB0325E-8C37-5525-96AC-0333523170A3
result	object	The index information.
name	string	The index name.	general
versions	array<object>	The information about the versions.
	object
desc	string	The description of the version.	close alarm, by 3.9.2 hotfix workflow
files	array<object>	The information about the files.
	object
fullPathName	string	The full path of the file.	" "
isDir	boolean	Indicates whether the file is a directory.	True
isTemplate	boolean	Indicates whether the file is a template.	True
name	string	The file name.	qrs.json
name	string	The version name.	ha-cn-7pp2ngv4s02_qrs
status	string	The status of the index version. Valid values: NEW: The index version is created. PUBLISH: The index version is normal. IN_USE: The index version is in use. NOT_USE: The index version is not used. STOP_USE: The index version is being stopped. RESTORE_USE: The index version is being restored. FAIL: The index version failed to be created.	2
updateTime	long	The time when the index version was updated.	" "
versionId	integer	The version ID.	1
dataSource	string	The name of the data source.	ha-cn-tl32nd2nq01_00
domain	string	The deployment name of the index.	sz_vpc_domain_1
indexStatus	string	The status of the index version. Valid values: NEW: The index version is created. PUBLISH: The index version is normal. IN_USE: The index version is in use. NOT_USE: The index version is not used. STOP_USE: The index version is being stopped. RESTORE_USE: The index version is being restored. FAIL: The index version failed to be created.	IN_USE
content	string	The file 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	integer	The number of shards.	2
fullVersion	long	The data version.	1688523414
fullUpdateTime	string	The time when full data in the index was last updated.	2024-06-20 08:52:54
incUpdateTime	string	The time when incremental data in the index was last updated.	2024-06-20 08:52:54
indexSize	long	The index size.	4689
description	string	The description of the index version.	test index
dataSourceInfo	object	The information about the data source.
processPartitionCount	integer	The number of resources used for data update.	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 data center in which the data source is deployed.	vpc_hz_domain_1
config	object	The configuration of MaxCompute data sources.
endpoint	string	The endpoint of the MaxCompute data source.	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	The AccessKey ID of the MaxCompute data source.	L***p
accessSecret	string	The AccessKey secret of the MaxCompute data source.	5**9a6
project	string	The name of the MaxCompute project that is used as the data source.	tisplus_dev
partition	string	The partition in the MaxCompute table. Example: ds=20180102.	ds=20220713
table	string	The name of the MaxCompute table that is used as the data source.	dump_odps_demo
namespace	string	The namespace. This parameter is applicable to the SARO data source used in the intranet of Alibaba Group.	TEST_dump_demo_sj_na61hunbu2_share_holo
path	string	The file path in the Apsara File Storage for HDFS file system.	http://test_opensearch/sift_oss_test.data
ossPath	string	The Object Storage Service (OSS) path.	/test_opensearch/sift_oss_test.data
bucket	string	The name of the OSS bucket.	ha3test-oss
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 table.	llm
autoBuildIndex	boolean	Indicates whether the automatic full indexing feature is enabled.	true
processParallelNum	integer	The maximum number of full indexes that can be concurrently processed.	2
cluster	object	The cluster information.
	object	The cluster information.
buildParallelNum	integer	The maximum number of full indexes that can be concurrently built.	2
mergeParallelNum	integer	The maximum number of full indexes that can be concurrently merged.	2
config	object	The configuration information.
	object	The configuration information.
	object	The information about the child configuration item.
name	string	The configuration name.	ha-cn-pl32rf0****_offline_adv_v1
updateTime	string	The time when the configuration was updated.	1716258634000
desc	string	The description of the advanced configuration.	Description
configWhenBuild	object	The configuration that takes effect next time.
	object	The configuration that takes effect next time.
	object	The child configuration item that takes effect next time.
name	string	The configuration name.	ha-cn-pl32rf0****_offline_adv_v1
updateTime	string	The time when the configuration was updated.	1716258634000
desc	string	The description of the advanced configuration.	Description

Examples

Sample success responses

JSONformat

{
  "requestId": "4FB0325E-8C37-5525-96AC-0333523170A3",
  "result": {
    "name": "general",
    "versions": [
      {
        "desc": "close alarm, by 3.9.2 hotfix workflow",
        "files": [
          {
            "fullPathName": "\" \"",
            "isDir": true,
            "isTemplate": true,
            "name": "qrs.json"
          }
        ],
        "name": "ha-cn-7pp2ngv4s02_qrs",
        "status": "2",
        "updateTime": 0,
        "versionId": 1
      }
    ],
    "dataSource": "ha-cn-tl32nd2nq01_00",
    "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": "test index",
    "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"
      },
      "saroConfig": {
        "namespace": "TEST_dump_demo_sj_na61hunbu2_share_holo",
        "tableName": "llm"
      },
      "autoBuildIndex": true,
      "processParallelNum": 2
    },
    "cluster": {
      "key": {
        "buildParallelNum": 2,
        "mergeParallelNum": 2
      }
    },
    "config": {
      "key": {
        "key": {
          "name": "\nha-cn-pl32rf0****_offline_adv_v1",
          "updateTime": "1716258634000",
          "desc": "Description\n"
        }
      }
    },
    "configWhenBuild": {
      "key": {
        "key": {
          "name": "\nha-cn-pl32rf0****_offline_adv_v1",
          "updateTime": "1716258634000",
          "desc": "Description\n"
        }
      }
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-16	The response structure of the API has changed	View Change Details
2023-07-20	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2022-01-12	Add Operation	View Change Details