GetElasticsearchIngestion - Simple Log Service - Alibaba Cloud Documentation Center

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/{esIngestionName} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
esIngestionName	string	Yes	The name of the ES/OpenSearch job.	ingest-elasticsearch-123456

Request parameters

Parameter	Type	Required	Description	Example
project	string	Yes	The name of the project.	ali-test-project

Response elements

Element	Type	Description	Example
	ESIngestion	The configuration of the ES/OpenSearch import job.

Examples

Success response

JSON format

{
  "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.