ListElasticsearchIngestions

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /elasticsearchingestions HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
project	string	Yes	The name of the project.	ali-test-project
offset	integer	No	The line from which to start the query. The default value is 0.	0
size	integer	No	The number of entries to return. The default value is 10.	10
logstore	string	No	The name of the Logstore.	ali-test-logstore

Response elements

Element	Type	Description	Example
	object	The response schema.
total	integer	The total number of Elasticsearch/OpenSearch import jobs in the project.	80
count	integer	The number of Elasticsearch/OpenSearch import jobs returned in the current request.	10
results	array	The list of Elasticsearch/OpenSearch import jobs.
	ESIngestion	The configuration of the Elasticsearch/OpenSearch import job.

Examples

Success response

JSON format

{
  "total": 80,
  "count": 10,
  "results": [
    {
      "name": "ingest-es-123456",
      "description": "es ingestion",
      "displayName": "es ingestion",
      "schedule": {
        "type": "FixedRate",
        "cronExpression": "0/5 * * * *",
        "runImmediately": false,
        "timeZone": "+0800",
        "delay": 4,
        "interval": "60s"
      },
      "configuration": {
        "logstore": "test-logstore",
        "source": {
          "BootstrapServers": "",
          "Index": "",
          "Username": "",
          "Password": "",
          "TimeFieldName": "",
          "TimeFormat": "",
          "TimeZone": "",
          "Query": "",
          "ConnectorMode": "",
          "StartTime": 0,
          "EndTime": 0,
          "MaxDataDelaySec": 0,
          "MinFragRangeSec": 0,
          "VpcId": ""
        }
      },
      "createTime": 1714360481,
      "lastModifiedTime": 1714360481,
      "status": "RUNNING",
      "scheduleId": "c7f01719d9feb105fc9d8df92af62010"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.