ListOSSIngestions - Simple Log Service - Alibaba Cloud Documentation Center

Queries a list of Object Storage Service (OSS) data import jobs in a project.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /ossingestions

Request parameters

Parameter	Type	Required	Description	Example

The current API does not require request parameters

Response parameters

Parameter	Type	Description	Example
headers	object
Server	string		nginx
Content-Type	string		application/json
Content-Length	string		0
Connection	string		close
x-log-requestid	string		5B0A6B60BB6EE39764D458B5
	object	Schema of Response
total	integer	The total number of OSS data import jobs in the project.	80
count	integer	The number of OSS data import jobs that are returned.	10
results	array	The OSS data import jobs.
	OSSIngestion	The configurations of the OSS data import job.

Examples

Sample success responses

JSONformat

{
  "total": 80,
  "count": 10,
  "results": [
    {
      "name": "ingest-oss-123456",
      "description": "oss ingestion",
      "displayName": "oss ingestion",
      "schedule": {
        "type": "FixedRate/Cron",
        "cronExpression": "0/5 * * * *",
        "runImmediately": false,
        "timeZone": "\"+0800\"",
        "delay": 4,
        "interval": "1m/1h"
      },
      "configuration": {
        "logstore": "myLogstore",
        "source": {
          "endpoint": "oss-cn-hangzhou.aliyuncs.com",
          "bucket": "ossbucket",
          "compressionCodec": "none,snappy,gzip",
          "encoding": "UTF-8",
          "format": {
            "key": "{\"type\": \"line\"}"
          },
          "interval": "never",
          "pattern": ".*",
          "prefix": "prefix",
          "restoreObjectEnabled": true,
          "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",
          "useMetaIndex": false,
          "roleARN": "acs:ram::12345:role/aliyunlogdefaultrole"
        }
      },
      "createTime": 1714360481,
      "lastModifiedTime": 1714360481,
      "status": "RUNNING",
      "scheduleId": "c7f01719d9feb105fc9d8df92af62010"
    }
  ]
}

Error codes

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