Lists S3 import tasks.
Try it now
Test
RAM authorization
Request syntax
GET /s3ingestions HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| project |
string |
No |
The name of the project. |
testproject |
| offset |
string |
No |
The starting position of the results to return. The default value is 0. |
0 |
| size |
string |
No |
The number of rows per page for a paged query. |
100 |
| logstore |
string |
No |
The name of the Logstore. |
test |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| total |
integer |
The total number of entries that match the query. |
3 |
| count |
integer |
The number of tasks returned on the current page. |
3 |
| results |
array |
The details of the task configurations. |
|
| S3Ingestion |
The details of the task configurations. |
Examples
Success response
JSON format
{
"total": 3,
"count": 3,
"results": [
{
"name": "ingest-s3-123456",
"description": "s3 ingestion",
"displayName": "s3 ingestion",
"schedule": {
"type": "Cron",
"cronExpression": "0/5 * * * *",
"runImmediately": false,
"timeZone": "\"+0800\"",
"delay": 4,
"interval": "1m/1h"
},
"configuration": {
"awsRegion": "ap-northeast-1",
"awsAccessKey": "AKIxxxxxxxxxxYJE",
"awsAccessKeySecret": "123xxxxxxxxxxfjf",
"bucket": "s3bucket",
"compressionCodec": "none",
"encoding": "UTF-8",
"format": {
"key": "{\"type\": \"line\"}"
},
"interval": "30m",
"pattern": ".*",
"prefix": "prefix",
"awsUseSQS": false,
"awsSQSQueueUrl": "https://sqs.ap-northeast-1.amazonaws.com/123456788/chifan",
"useAwsSQSOnly": false,
"tagPackId": false,
"startTime": 1714274081,
"endTime": 1714360481,
"timeField": "__time__",
"timeFormat": "yyyy-MM-dd HH:mm:ss",
"timePattern": "[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+",
"timeZone": "GMT+08:00",
"processorId": "ingest-processor-1756802123-953901",
"endpoint": "s3.us-east-1.amazonaws.com"
},
"createTime": 1714360481,
"lastModifiedTime": 1714360481,
"status": "RUNNING",
"scheduleId": "c7f01719d9feb105fc9d8df92af62010",
"processorId": "ingest-processor-1756802123-953901"
}
]
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.