ListAzureBlobIngestion

Updated at:
Copy as MD

Lists Azure Blob ingestion tasks.

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 /azureblobingestions HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

project

string

Yes

The name of the project.

offset

integer

No

The number of tasks to skip before returning results. Default: 0.

size

integer

No

The number of tasks to return per page. Range: 0 to 500. Default: 100.

logstore

string

No

The name of the logstore. If specified, the operation returns only tasks from this logstore.

Response elements

Element

Type

Description

Example

object

The returned data.

total

integer

The total number of tasks that match the query.

count

integer

The number of tasks returned on the current page.

results

array

A list of Azure Blob ingestion tasks.

AzureBlobIngestion

Examples

Success response

JSON format

{
  "total": 0,
  "count": 0,
  "results": [
    {
      "name": "ingest-azure-blob-123456",
      "description": "azure blob ingestion",
      "displayName": "azure blob ingestion",
      "schedule": {
        "type": "FixedRate",
        "cronExpression": "0/5 * * * *",
        "runImmediately": false,
        "timeZone": "+0800",
        "delay": 4,
        "interval": "60s"
      },
      "configuration": {
        "logstore": "myLogstore",
        "source": {
          "compressionCodec": "none",
          "encoding": "UTF-8",
          "interval": "30m",
          "pattern": ".*",
          "prefix": "prefix",
          "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",
          "accountName": "test001",
          "accountKey": "dGVzdGtleQ==",
          "containerName": "test-container",
          "endpoint": "https://your-storage.blob.core.windows.net",
          "format": {
            "key": "{\"type\": \"line\"}"
          },
          "advancedParameters": {
            "key": ""
          }
        }
      },
      "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.