文档

GetIndex - 获取集群可回滚的索引信息

更新时间:

查看索引表版本详情。

接口说明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/indexes/{indexName}?dataSource=xxx

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
searchengine:GetIndexRead
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

请求语法

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

请求参数

名称类型必填描述示例值
instanceIdstring

实例 ID

ha-cn-8ed2j834u03
indexNamestring

索引名称

index_jiayi_text

请求示例

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

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

id of request

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

索引信息

namestring

索引名称

general
versionsobject []

版本信息

descstring

描述信息

close alarm, by 3.9.2 hotfix workflow
filesobject []

所在位置

fullPathNamestring

完整路径

" "
isDirboolean

是文件夹

True
isTemplateboolean

是模板

True
namestring

版本名称

ha-cn-7pp2ngv4s02_qrs
statusstring

状态

2
updateTimelong

更新时间

" "
versionIdinteger

版本 ID

1
dataSourcestring

数据源

ha-cn-tl32nd2nq01_00
domainstring

数据源的部署名

indexStatusstring

表状态 (NEW, PUBLISH, IN_USE: 召回引擎版创建成功后为正常状态, NOT_USE, STOP_USE,RESTORE_USE)

contentstring

文件内容

partitioninteger

数据分片

fullVersionlong

数据版本

fullUpdateTimestring

全量切换时间

incUpdateTimestring

增量更新时间

indexSizelong

索引大小

descriptionstring

备注

dataSourceInfoobject

数据源相关信息

processPartitionCountinteger

数据更新资源数

namestring

数据源名

typestring

数据源类型 (odps, swift, saro, oss, unKnow)

domainstring

离线部署

configobject

odps 数据源配置

endpointstring

odps 相关

tablestring

saro、odps 相关

namespacestring

saro 相关

pathstring

hdfs 相关

ossPathstring

oss 数据源相关

saroConfigobject

saro 数据源配置

autoBuildIndexboolean

是否开启自动全量

返回示例

正确返回

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": {
    "name": "index1",
    "dataSource": "test_yyds_data1",
    "versions": [
      {
        "name": "my_index_1",
        "versionId": 1,
        "status": "drafting",
        "updateTime": "1631070464000",
        "desc": "test",
        "files": [
          {
            "fullPathName": "/",
            "isDir": true,
            "isTemplate": true,
            "name": "cava"
          },
          {
            "fullPathName": "/",
            "isDir": true,
            "isTemplate": true,
            "name": "cava"
          }
        ]
      },
      {
        "name": "my_index_2",
        "versionId": 1,
        "status": "drafting",
        "updateTime": "1631070464000",
        "desc": "test",
        "files": [
          {
            "fullPathName": "/",
            "isDir": true,
            "isTemplate": true,
            "name": "cava"
          },
          {
            "fullPathName": "/",
            "isDir": true,
            "isTemplate": true,
            "name": "cava"
          }
        ]        
      }
    ]
  }
}

示例

正常返回示例

JSON格式

{
  "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": ""
          }
        ],
        "name": "ha-cn-7pp2ngv4s02_qrs",
        "status": "2",
        "updateTime": 0,
        "versionId": 1
      }
    ],
    "dataSource": "ha-cn-tl32nd2nq01_00",
    "domain": "",
    "indexStatus": "",
    "content": "",
    "partition": 0,
    "fullVersion": 0,
    "fullUpdateTime": "",
    "incUpdateTime": "",
    "indexSize": 0,
    "description": "",
    "dataSourceInfo": {
      "processPartitionCount": 0,
      "name": "",
      "type": "",
      "domain": "",
      "config": {
        "endpoint": "",
        "accessKey": "",
        "accessSecret": "",
        "project": "",
        "partition": "",
        "table": "",
        "namespace": "",
        "path": "",
        "ossPath": "",
        "bucket": ""
      },
      "saroConfig": {
        "namespace": "",
        "tableName": ""
      },
      "autoBuildIndex": true
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-20OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    删除入参:dataSource
出参OpenAPI 返回结构发生变更
2022-01-12新增 OpenAPI看变更集
  • 本页导读 (0)
文档反馈