All Products
Search
Document Center

Simple Log Service:ListOSSIngestions

Last Updated:Nov 13, 2024

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

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /ossingestions HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
headersobject
Serverstring
nginx
Content-Typestring
application/json
Content-Lengthstring
0
Connectionstring
close
x-log-requestidstring
5B0A6B60BB6EE39764D458B5
object

Schema of Response

totalinteger

The total number of OSS data import jobs in the project.

80
countinteger

The number of OSS data import jobs that are returned.

10
resultsarray

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.