DocsICP FilingConsole
Documentation

GetIndex

Updated at:
Copy as MD
Product
My Favorites

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 None

Request syntax

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

Path Parameters

Parameter

Type

Required

Description

Example
instanceId

string

Yes

The instance ID.

ha-cn-pl32rf0****
indexName

string

Yes

The index name.

test_api

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Sample request

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.

array<object>

The data version information.

desc

string

The description information.

Index Note
files

array<object>

The location.

object

The version details.

fullPathName

string

The full path.

/qrs.json

isDir

boolean

Specifies whether the item is a folder.

true
isTemplate

boolean

Specifies whether the item is a template.

true
name

string

The file name.

qrs.json
name

string

The version name.

test
status

string

The status. Valid values:

  • NEW: created

  • PUBLISH: normal

  • IN_USE: in use

  • NOT_USE: not in use

  • STOP_USE: stopping use

  • RESTORE_USE: resuming use

  • FAIL: failed

PUBLISH
updateTime

integer

The update time. The value is a UNIX timestamp in seconds.

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. Valid values:

  • NEW: created

  • PUBLISH: normal

  • IN_USE: in use

  • NOT_USE: not in use

  • STOP_USE: stopping use

  • RESTORE_USE: resuming use

  • FAIL: failed

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 data shard.

2
fullVersion

integer

The data version.

1688523414
fullUpdateTime

string

The full switchover time. The format is YYYY-MM-DD HH:mm:ss.

2024-06-20 08:52:54
incUpdateTime

string

The incremental update time. The format is YYYY-MM-DD HH:mm:ss.

2024-06-20 08:52:54
indexSize

integer

The index size.

4689
description

string

The description.

note
dataSourceInfo

object

The data source information.

processPartitionCount

integer

The number of data update resources.

2
name

string

The data source name.

ha-cn-pl32rf0****_test_api

type

string

The data source type. Valid values: odps, swift, saro, oss, and unKnow.

odps
domain

string

The offline deployment.

vpc_hz_domain_1
config

object

The ODPS datasource config.

endpoint

string

The ODPS-related information.

http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey

string

The AccessKey ID of the ODPS data source.

L***p
accessSecret

string

The AccessKey secret of the ODPS data source.

5**9a6
project

string

The project name of the ODPS data source.

tisplus_dev
partition

string

The ODPS partition. Example: ds=20180102.

ds=20220713
table

string

The Saro and ODPS-related information.

dump_odps_demo
namespace

string

The Saro-related information.

TEST_dump_demo_sj_na61hunbu2_share_holo
path

string

The HDFS-related information.

http://test_opensearch/sift_oss_test.data
ossPath

string

The OSS data source-related information.

/test_opensearch/sift_oss_test.data
bucket

string

The bucket name.

ha3test-oss
format

string

The file format type of OSS. Valid values:

  • 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 Saro datasource config.

namespace

string

The namespace of the Saro data source.

TEST_dump_demo_sj_na61hunbu2_share_holo
tableName

string

The table name of the Saro data source.

llm
autoBuildIndex

boolean

Specifies whether automatic full build is enabled.

true
processParallelNum

integer

The number of concurrent full build processes.

2
createTime

string

The creation time. The format is YYYY-MM-DD HH:mm:ss.

2024-05-21 16:05:26
updateTime

string

The update time. The format is YYYY-MM-DD HH:mm:ss.

2024-05-21 16:05:26
cluster

object

The cluster information.

object

The cluster information.

buildParallelNum

integer

The number of concurrent full build tasks.

2
mergeParallelNum

integer

The number of concurrent full build merge tasks.

2
config

object

The configuration information.

object

The configuration information.

object

The child configuration item information.

name

string

The configuration name.

ha-cn-pl32rf0****_offline_adv_v1
updateTime

string

The update time. The value is a UNIX timestamp in milliseconds.

1716258634000
desc

string

The description of the advanced configuration.

Note Information
configWhenBuild

object

The configuration that takes effect on the next build.

object

The configuration that takes effect on the next build.

object

The child configuration items that take effect next time.

name

string

The configuration name.

ha-cn-pl32rf0****_offline_adv_v1
updateTime

string

The update time. The value is a UNIX timestamp in milliseconds.

1716258634000
desc

string

The description of the advanced configuration.

Note Information
extend

object

The extended information.

array

The extended information.

string

The extended information.

Extended Information

Sample response

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.