全部產品
Search
文件中心

OpenSearch:GetIndex - 查看索引表詳情

更新時間:Sep 29, 2025

查看索引表版本詳情。

介面說明

方法

GET

URI

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

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

searchengine:GetIndex

get

*Instance

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

請求文法

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

請求參數

名稱

類型

必填

描述

樣本值

instanceId

string

執行個體 ID

ha-cn-pl32rf0****

indexName

string

索引名稱

test_api

請求樣本

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

返回參數

名稱

類型

描述

樣本值

object

requestId

string

請求 ID。

4FB0325E-8C37-5525-96AC-0333523170A3

result

object

索引資訊

name

string

索引名稱

test_api

versions

array<object>

版本資訊

object

資料版本資訊

desc

string

描述資訊

Index Note

files

array<object>

所在位置

object

版本詳情

fullPathName

string

完整路徑

/qrs.json

isDir

boolean

是檔案夾

true

isTemplate

boolean

是模板

true

name

string

檔案名稱

qrs.json

name

string

版本名稱

test

status

string

狀態

  • NEW:建立。

  • PUBLISH:正常。

  • IN_USE:使用中。

  • NOT_USE:未使用。

  • STOP_USE:停止使用中。

  • RESTORE_USE:恢複使用中。

  • FAIL:失敗。

PUBLISH

updateTime

integer

更新時間

1718846192

versionId

integer

版本 ID

1

dataSource

string

資料來源

ha-cn-pl32rf0****_test_api

domain

string

資料來源的部署名

sz_vpc_domain_1

indexStatus

string

狀態

  • NEW:建立。

  • PUBLISH:正常。

  • IN_USE:使用中。

  • NOT_USE:未使用。

  • STOP_USE:停止使用中。

  • RESTORE_USE:恢複使用中。

  • FAIL:失敗。

IN_USE

content

string

檔案內容

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

資料分區

2

fullVersion

integer

資料版本

1688523414

fullUpdateTime

string

全量切換時間

2024-06-20 08:52:54

incUpdateTime

string

累加式更新時間

2024-06-20 08:52:54

indexSize

integer

索引大小

4689

description

string

備忘

note

dataSourceInfo

object

資料來源相關資訊

processPartitionCount

integer

資料更新資源數

2

name

string

資料來源名

ha-cn-pl32rf0****_test_api

type

string

資料來源類型 (odps, swift, saro, oss, unKnow)

odps

domain

string

離線部署

vpc_hz_domain_1

config

object

odps 資料來源配置

endpoint

string

odps 相關

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

accessKey

string

odps 資料來源 ak

L***p

accessSecret

string

odps 資料來源 ak secret

5**9a6

project

string

odps 資料來源專案名稱

tisplus_dev

partition

string

ODPS Partition。例如:ds=20180102

ds=20220713

table

string

saro、odps 相關

dump_odps_demo

namespace

string

saro 相關

TEST_dump_demo_sj_na61hunbu2_share_holo

path

string

hdfs 相關

http://test_opensearch/sift_oss_test.data

ossPath

string

oss 資料來源相關

/test_opensearch/sift_oss_test.data

bucket

string

Bucket 名稱。

ha3test-oss

format

string

oss 的檔案格式類型

  • ha3

  • json

ha3

catalog

string

dlf 資料來源-資料目錄 ID

clg-paimon-21cc136237a6457f8618f5f82d116d7e

database

string

dlf 資料來源-資料庫

dlf_test

tag

string

dlf 資料來源-tag

test_tag

saroConfig

object

saro 資料來源配置

namespace

string

saro 資料來源的 namespace

TEST_dump_demo_sj_na61hunbu2_share_holo

tableName

string

saro 資料表名稱

llm

autoBuildIndex

boolean

是否開啟自動全量

true

processParallelNum

integer

全量 process 並發數

2

createTime

string

建立時間

2024-05-21 16:05:26

updateTime

string

更新時間

2024-05-21 16:05:26

cluster

object

叢集資訊

object

叢集資訊

buildParallelNum

integer

全量並發數

2

mergeParallelNum

integer

全量 merge 並發數

2

config

object

配置資訊

object

配置資訊

configWhenBuild

object

下次生效的配置

object

下次生效的配置

extend

object

擴充資訊

array

擴充資訊

返回樣本

正確返回

{
    "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
    "result": {
        "name": "index-name",
        "dataSource": "ha-cn-xxx-index-name",
        "domain": "test", // 資料來源的部署名稱
        "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\":\"備忘 2\"}",
                "{\"feild3\":\"備忘 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": "描述"
            },
            "OFFLINE_TABLE": {
                "name": "ha-cn-finxmo71065_table_ha-cn-finxmo71065_test_saro_v2",
                "updateTime": 1709261682000,
                "desc": "描述"
            },
            "OFFLINE_COMMON": {
                "name": "ha-cn-finxmo71065_offline_adv_v2",
                "updateTime": 1709259817000,
                "desc": "描述"
            },
            "OFFLINE_PLUGIN": {
                "name": "ha-cn-finxmo71065_offline_plugin_v2",
                "updateTime": 1709259817000,
                "desc": "描述"
            },
            "OFFLINE_INDEX": {
                "name": "ha-cn-finxmo71065@ha-cn-finxmo71065_test_saro@test_saro@index_config_v2",
                "updateTime": 1709259817000,
                "desc": "描述"
            }
        },
        "configWhenBuild": {
            "OFFLINE_DICT": {
                "name": "ha-cn-finxmo71065_offline_dict_v2",
                "updateTime": 1709259817000,
                "desc": "描述"
            },
            "OFFLINE_TABLE": {
                "name": "ha-cn-finxmo71065_table_ha-cn-finxmo71065_test_saro_v2",
                "updateTime": 1709261682000,
                "desc": "描述"
            },
            "OFFLINE_COMMON": {
                "name": "ha-cn-finxmo71065_offline_adv_v2",
                "updateTime": 1709259817000,
                "desc": "描述"
            },
            "OFFLINE_PLUGIN": {
                "name": "ha-cn-finxmo71065_offline_plugin_v2",
                "updateTime": 1709259817000,
                "desc": "描述"
            },
            "OFFLINE_INDEX": {
                "name": "ha-cn-finxmo71065@ha-cn-finxmo71065_test_saro@test_saro@index_config_v2",
                "updateTime": 1709259817000,
                "desc": "描述"
            }
        }
    }

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情