tencent cloud



Last updated: 2022-09-16 15:31:30

1. API Description

Domain name for API request: cls.tencentcloudapi.com.

This API is used to create a shipping rule. Note: To use this API, you need to check whether you have configured the role and permission for COS shipping tasks. If not, see Viewing and Configuring Shipping Authorization at https://www.tencentcloud.com/document/product/614/71623.?from_cn_redirect=1

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateShipper.
Version Yes String Common Params. The value used for this API: 2020-10-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
TopicId Yes String ID of the log topic to which the shipping rule to be created belongs
Bucket Yes String Destination bucket in the shipping rule to be created
Prefix Yes String Prefix of the shipping directory in the shipping rule to be created
ShipperName Yes String Shipping rule name
Interval No Integer Interval between shipping tasks (in sec). Default value: 300. Value range: 300-900
MaxSize No Integer Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 100-256
FilterRules.N No Array of FilterRuleInfo Filter rules for shipped logs. Only logs matching the rules can be shipped. All rules are in the AND relationship, and up to five rules can be added. If the array is empty, no filtering will be performed, and all logs will be shipped.
Partition No String Rules for partitioning logs to be shipped. strftime can be used to define the presentation of time format.
Compress No CompressInfo Compression configuration of shipped log
Content No ContentInfo Format configuration of shipped log content
FilenameMode No Integer Naming a shipping file. Valid values: 0 (by random number); 1 (by shipping time). Default value: 0.

3. Output Parameters

Parameter Name Type Description
ShipperId String Shipping rule ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating shipping rules

Input Example

Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateShipper
<Common request parameters>

    "TopicId": "xxxx-xx-xx-xx-xxxxxxxx",
    "Bucket": "test-1250000001",
    "Prefix": "test",
    "ShipperName": "myname",
    "Interval": 300,
    "MaxSize": 256,
    "Partition": "%Y%m%d",
    "Compress": {
        "Format": "none"
    "FilterRules": [
            "Key": "",
            "Regex": "",
            "Value": ""
    "FilenameMode": 0

Output Example

    "Response": {
        "ShipperId": "xxxx-xx-xx-xx-xxxxxxxx",
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure CAM signature/authentication error.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameter.ShipperConflict Shipping rule naming conflict.
InvalidParameterValue Incorrect parameter value.
LimitExceeded.Shipper The number of shipping rules exceeds the limit.
MissingParameter Missing parameter.
OperationDenied Operation denied.
OperationDenied.ACLFailed ACL verification failed.
OperationDenied.AccountDestroy The account has been terminated.
OperationDenied.AccountIsolate The account has overdue payments.
OperationDenied.AccountNotExists The account does not exist.
ResourceNotFound.TopicNotExist The log topic does not exist.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support