GetOSSExport - Simple Log Service - Alibaba Cloud Documentation Center

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 /ossexports/{ossExportName} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ossExportName	string	Yes	The unique name of the existing job.	export-oss-123456789-123456

Request parameters

Parameter	Type	Required	Description	Example
project	string	Yes	The name of the project.	my-project

Response elements

Element	Type	Description	Example
	OSSExport	The details of the job configuration.

Examples

Success response

JSON format

{
  "name": "myossexportjob",
  "description": "This is a oss export",
  "displayName": "This is a oss export",
  "configuration": {
    "logstore": "logstore-demo",
    "roleArn": "acs:ram::123456789:role/aliyunlogdefaultrole",
    "sink": {
      "endpoint": "http://xxxxxxxx",
      "bucket": "test-bucket",
      "prefix": "prefixxxx/",
      "suffix": ".json",
      "roleArn": "acs:ram::xxxxxxx",
      "pathFormat": "%Y_%m_%d/good/bad",
      "pathFormatType": "only support time",
      "timeZone": "+0800",
      "contentType": "json/parquet/csv/orc",
      "contentDetail": {
        "key": "{\n    \"columns\": [\n        \"your log key1\",\n        \"your log key2\",\n        \"your log key3\",\n    ],\n    \"delimiter\": \" \",\n    \"header\": True,\n    \"lineFeed\": \"\\n\",\n    \"null\": \"-\",\n    \"quote\": \"\\\"\"\n},"
      },
      "compressionType": "snappy/gizp/zstd/none",
      "bufferInterval": 300,
      "bufferSize": 256,
      "delaySec": 123,
      "delaySeconds": 900
    },
    "fromTime": 123456789,
    "toTime": 123456789
  },
  "createTime": 123456789,
  "lastModifiedTime": 123456789,
  "status": "RUNNING",
  "scheduleId": "c7f01719d9feb105fc9d8df92af62010"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.