全部产品
Search
文档中心

智能开放搜索 OpenSearch:GetIndexVersion - 获取集群可回滚的索引信息

更新时间:Oct 16, 2024

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

接口说明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/clusters/{clusterName}/index-version

调试

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

授权信息

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

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

请求语法

GET /openapi/ha3/instances/{instanceId}/clusters/{clusterName}/index-version HTTP/1.1

请求参数

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

实例 ID

ha-cn-pl32rf0****
clusterNamestring

集群名称

vpc_hz_domain_1

示例

请求示例

GET  /openapi/ha3/instances/ha3_instance_id_1/clusters/cluster1/index-version

返回参数

名称类型描述示例值
object
requestIdstring

请求 ID。

E7B7D598-B080-5C8E-AA35-D43EC0D5F886
resultobject

集群列表

clusterstring

集群名称

hz_pre_vpc_domain_1
indexVersionsarray<object>

索引版本列表

indexVersionsobject

索引版本信息

indexNamestring

索引表名称

test_api
versionsarray

索引版本

versionslong

索引版本

1630353700
buildDeployIdstring

离线部署 id

2648
currentVersionlong

当前在线版本号

1

返回示例

正确返回

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": {
    "cluster": "ea119cloud",
    "indexVersions": [
      {
        "versions": [
          1630527077,
          1630440554
        ],
        "currentVersion":1630527077,
        "indexName": "ihome_lapp_content_filter_param_index",
        "buildDeployId": "2837"
      },
      {
        "versions": [
          1630353700
        ],
        "currentVersion":1630353700,        
        "indexName": "ihome_lapp_case_tab_filter",
        "buildDeployId": "2829"
      }
    ]
  }
}

示例

正常返回示例

JSON格式

{
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": {
    "cluster": "hz_pre_vpc_domain_1",
    "indexVersions": [
      {
        "indexName": "test_api",
        "versions": [
          1630353700
        ],
        "buildDeployId": "2648",
        "currentVersion": 1
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-01-12新增 OpenAPI查看变更详情