全部产品
Search
文档中心

智能开放搜索 OpenSearch:ListDateSourceGenerations - 获取数据源的历史回流信息

更新时间:Oct 16, 2024

获取数据源的历史回流信息。

接口说明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/generations?domainName={domainName}

调试

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

授权信息

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

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

请求语法

GET /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/generations HTTP/1.1

请求参数

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

实例 id。

ha-cn-pl32rf0****
dataSourceNamestring

数据源名称。

ha-cn-pl32rf0****_test_api
validStatusboolean

有效状态(默认为 true)

  1. true 返回 Task 执行完成且未过期的 generation
  2. false 返回所有 generation
true
domainNamestring

数据源部署机房

bj_vpc_domain_1

请求示例

GET /openapi/ha3/instances/ha3_instances_id/data-sources/my_data_source/generations??domainName=pre_domain_1

返回参数

名称类型描述示例值
object
requestIdstring

请求 ID。

022F36C7-9FB4-5D67-BEBC-3D14B0984463
resultarray<object>

返回结果

itemobject

返回结果

generationlong

索引全量版本

1626143930
createTimelong

build index 开始时间

1626143673
statusstring

状态

STOPPED
buildDeployIdinteger

离线部署 id

122
partitionobject

Key 索引名称 value 分片数量

integer

分片数

1
timestamplong

增量时间戳

1626143673
dataDumpRootstring

dump 表索引文件存储地址

hdfs://opensearch/dump.json

返回示例

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    {
      "generationId":1626143930,
      "timestamp":16261436737,
      "createTime":1626143673,
      "status":"STOPPED",
      "partition":{
        "index1":1
      },
      "buildDeployId":122
    },{
      "generationId":1626143930,
      "timestamp":16261435453,
      "createTime":1626143673,
      "status":"STOPPED",
      "partition":{
        "index1":1
      },
      "buildDeployId":122
    }
  ]
}

示例

正常返回示例

JSON格式

{
  "requestId": "022F36C7-9FB4-5D67-BEBC-3D14B0984463",
  "result": [
    {
      "generation": 1626143930,
      "createTime": 1626143673,
      "status": "STOPPED",
      "buildDeployId": 122,
      "partition": {
        "key": 1
      },
      "timestamp": 1626143673,
      "dataDumpRoot": "hdfs://opensearch/dump.json"
    }
  ]
}

错误码

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