ListOSSIngestions

Updated at: 2025-02-12 10:07

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
OperationAccess levelResource typeCondition keyAssociated operation
log:ListOSSIngestionslist
*All Resources
*
    none
none

Request syntax

GET /ossingestions HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
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.

  • On this page (1)
  • Debugging
  • Authorization information
  • Request syntax
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
Feedback
phone Contact Us

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare