GetOSSHDFSExport

Updated at: 2025-02-12 10:10

Queries the information about an OSS-HDFS data shipping job.

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

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
projectstringYes

The name of the project.

ali-test-project
ossExportNamestringYes

The unique name of the job. Make sure that the job exists.

job-123456789-123456

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
OSSExport

Examples

Sample success responses

JSONformat

{
  "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

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