tencent cloud

All product documents
APIs
DocumentationAPIsCloud Log ServiceCOS Task APIsModifyShipper
ModifyShipper
Last updated: 2024-04-15 19:58:43
ModifyShipper
Last updated: 2024-04-15 19:58:43

1. API Description

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

This API is used to modify an existing shipping rule. To use this API, you need to grant CLS the write permission of the specified bucket.

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: ModifyShipper.
Version Yes String Common Params. The value used for this API: 2020-10-16.
Region No String Common Params. This parameter is not required for this API.
ShipperId Yes String Shipping rule ID
Bucket No String New destination bucket in shipping rule
Prefix No String New destination directory prefix in shipping rule
Status No Boolean Shipping rule status
ShipperName No String Shipping rule name
Interval No Integer Shipping time interval in seconds. Default value: 300. Value range: 300 to 900
MaxSize No Integer Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 5 to 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 Partition rule of shipped log, which can be represented in strftime 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.
StorageType No String COS bucket type

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modifying a COS Shipping Task

This example shows you how to modify a COS shipping task.

Input Example

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

{
    "ShipperId": "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": {
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

5. Developer Resources

SDK

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.
InvalidParameterValue Incorrect parameter value.
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 The resource does not exist.
ResourceNotFound.ShipperNotExist The shipping rule does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

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

Contact Us
Technical Support

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

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon