修改投递规则

最近更新时间: 2026-09-17 00:06:36

1. 接口描述

接口请求域名： cls.api3.fincloud.tencent.cn。

修改现有的投递规则，客户如果使用此接口，需要自行处理CLS对指定bucket的写权限。

默认接口请求频率限制：20次/秒。

接口更新时间：2025-07-30 01:44:57。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：ModifyShipper
Version 是 否 String 公共参数，本接口取值：2020-10-16
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
ShipperId 是 否 String 投递规则ID
示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Bucket 否 否 String COS存储桶，详见产品支持的存储桶命名规范。
示例值： examplebucket-1250000000
Prefix 否 否 String 投递规则投递的新的目录前缀。  仅支持0-9A-Za-z-_/ 最大支持256个字符
示例值： var/log
Status 否 否 Bool 投递规则的开关状态。true：开启投递任务；false：关闭投递任务。
示例值： true
ShipperName 否 否 String 投递规则的名字
示例值： shipper_name
Interval 否 否 Uint64 投递的时间间隔，单位 秒，默认300，范围 300-900
示例值： 300
MaxSize 否 否 Uint64 投递的文件的最大值，单位 MB，默认100，范围 5-256
示例值： 100
FilterRules 否 否 Array of FilterRuleInfo 投递日志的过滤规则，匹配的日志进行投递，各rule之间是and关系，最多5个，数组为空则表示不过滤而全部投递
示例值：查看
Partition 否 否 String 投递日志的分区规则，支持strftime的时间格式表示
示例值： %Y%m%d
Compress 否 否 CompressInfo 投递日志的压缩配置
示例值：查看
Content 否 否 ContentInfo 投递日志的内容格式配置
示例值：查看
FilenameMode 否 否 Uint64 投递文件命名配置，0：随机数命名，1：投递时间命名。
示例值： 0
CustomUin 否 否 Uint64 跨账号uin，用于支持跨账号bucket投递
示例值： 1670641097

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码 描述
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InternalError 内部错误。
ResourceNotFound 资源不存在。
FailedOperation 操作失败。
AuthFailure CAM签名/鉴权错误。
OperationDenied.ACLFailed ACL校验失败。
ResourceNotFound.ShipperNotExist 投递规则不存在。
OperationDenied.AccountIsolate 账户欠费。
OperationDenied.AccountDestroy 账户已销毁。
OperationDenied.AccountNotExists 账户不存在。

5. 示例

示例1 修改投递规则

输入示例

POST / HTTP/1.1
Host: cls.api.com
Content-Type: application/json
X-TC-Action: ModifyShipper
<公共请求参数>

{
    "ShipperId":"dfa4ac24-caa1-4e30-a027-349cb29937c4",
    "Bucket":"test-1250000001",
    "Prefix":"test",
    "ShipperName":"myname",
    "Interval":300,
    "MaxSize":256,
    "Partition":"%Y%m%d",
    "Compress":{
        "Format":"none"
    },
    "FilterRules":[
        {
            "Key":"",
            "Regex":"",
            "Value":""
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}