ListDateSourceGenerations - OpenSearch - Alibaba Cloud Documentation Center

Queries the historical index versions of a data source.

Operation description

Method

GET

URI

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-7mz2ttxta01
dataSourceName	string	Yes	The name of the data source.	ha-cn-0ju2s170b03_test_api2
validStatus	boolean	No	Specifies the index versions to be returned. Valid values: true (default): returns the index versions that are complete and not expired. false: returns all index versions.	true
domainName	string	Yes	The data center where the data source is deployed.	bj_vpc_domain_1

Sample requests

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

Response parameters

Parameter	Type	Description	Example
	object
requestId	string	id of request	022F36C7-9FB4-5D67-BEBC-3D14B0984463
result	array<object>	List
item	object	The result returned.
generation	long	The ID of the full index version.	1626143930
createTime	long	The timestamp that was generated when the index building was started.	1626143673
status	string	The status of the index version.	STOPPED
buildDeployId	integer	The ID of the offline deployment.	122
partition	object	The shards of the index version. The value is a key-value pair in which the key indicates the index name and the value indicates the number of shards. The number of value shards.
	integer	The number of shards.	1
timestamp	long	The start timestamp from which incremental data is retrieved.	1626143673
dataDumpRoot	string	The path of the dumped index in the Apsara File Storage for HDFS file system.	""

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.