获取索引表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| searchengine:GetTable |
|
| 无 |
请求语法
GET /openapi/ha3/instances/{instanceId}/tables/{tableName}
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 实例 ID | ha-cn-pl32rf0**** |
| tableName | string | 是 | 索引表名称 | test_summary |
返回参数
示例
正常返回示例
JSON格式
{
"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": "INT64"
},
"vectorIndex": [
{
"indexName": "test_odps",
"vectorField": "source_image_vector",
"sparseIndexField": "sparse_indices",
"sparseValueField": "sparse_values",
"dimension": "128",
"vectorIndexType": "Qc",
"distanceType": "SquaredEuclidean",
"namespace": "namespace",
"advanceParams": {
"buildIndexParams": "{\n \"proxima.qc.builder.quantizer_class\": \"Int8QuantizerConverter\",\n \"proxima.qc.builder.quantize_by_centroid\": true,\n \"proxima.qc.builder.optimizer_class\": \"BruteForceBuilder\",\n \"proxima.qc.builder.thread_count\": 10,\n \"proxima.qc.builder.optimizer_params\": {\n \"proxima.linear.builder.column_major_order\": true\n },\n \"proxima.qc.builder.store_original_features\": false,\n \"proxima.qc.builder.train_sample_count\": 3000000,\n \"proxima.qc.builder.train_sample_ratio\": 0.5\n}",
"searchIndexParams": "{\"proxima.qc.searcher.scan_ratio\":0.01}",
"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"
}
}
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-05-09 | OpenAPI 返回结构发生变更 | 查看变更详情 |