All Products
Search

This Product

    OpenSearch:ListDateSourceGenerations

    Document Center

    OpenSearch:ListDateSourceGenerations

    Last Updated:Aug 11, 2026

    Retrieves the historical data backflow information of a data source.

    Operation description

    Method

    GET

    URI

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

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    searchengine:ListDateSourceGenerations

    list

    *Instance

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

    		 None None

    Request syntax

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

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    instanceId

    string

    Yes

    The instance ID.

    ha-cn-pl32rf0****
    dataSourceName

    string

    Yes

    The name of the data source.

    ha-cn-pl32rf0****_test_api

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    validStatus

    boolean

    No

    The valid status. Default value: true.

    1. true: Returns generations for which the task is completed and not expired.

    2. false: Returns all generations.

    true
    domainName

    string

    Yes

    The data center where the data source is deployed.

    bj_vpc_domain_1

    Request example

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

    Response elements

    Element

    Type

    Description

    Example

    object

    requestId

    string

    The request ID.

    022F36C7-9FB4-5D67-BEBC-3D14B0984463
    result

    array<object>

    The returned results.

    array<object>

    The returned results.

    generation

    integer

    The full index version.

    1626143930
    createTime

    integer

    The start time of the build index operation.

    1626143673
    status

    string

    The status.

    STOPPED
    buildDeployId

    integer

    The offline deployment ID.

    122
    partition

    object

    Key: the index name. Value: the number of shards.

    integer

    The number of shards.

    1
    timestamp

    integer

    The incremental timestamp.

    1626143673
    dataDumpRoot

    string

    The storage path of the dump table index file.

    hdfs://opensearch/dump.json
    outPutType

    string

    The export type. Valid values:

    • api (default): restores to HDFS.

    • oss: exports to OSS.

    • odps: exports to ODPS.

    This parameter has a value only when the dump table is restored from an index. The value is empty for common tables.

    Response example

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

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.