tencent cloud

Feature

This API is used to create a shipping task. When using this API, you need to manually grant CLS the permission to write to the specified bucket.

Request

Request samples

POST /shipper HTTP/1.1
Host: <Region>.cls.tencentyun.com
Authorization: <AuthorizationString>
Content-Type: application/json

{
  "topic_id": "xxxx-xx-xx-xx-xxxxxxxx",
  "bucket": "test-1250000001",
  "prefix": "test",
  "shipper_name": "myname",
  "interval": 300,
  "max_size": 100,
  "partition": "%Y%m%d",
  "compress": {
    "format": "none"
  },
  "content": {
    "format": "csv",
    "csv_info": {
      "print_key": true,
      "keys": ["key1", "key2"],
      "delimiter": "|",
      "escape_char": "'",
      "non_existing_field": "null"
    }
  }
}

Request line

POST /shipper

Request headers

No special request header is used except for the common header.

Request parameters

compress is composed as follows:

content is composed as follows:

csv_info is composed as follows:

Response

Response sample

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 0
{
 "shipper_id": "xxxx-xx-xx-xx-xxxxxxxx",
}

Response headers

No special response header is used except for the common response header.

Response parameters

Error Codes

For more information, see Error Codes.