1. 接口描述
接口请求域名： cls.tencentcloudapi.com 。
修改现有的投递规则，客户如果使用此接口，需要自行处理CLS对指定bucket的写权限。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyShipper。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ShipperId | 是 | String | 投递规则ID 示例值：3f9562a7-xxxx-xxxx-b32a-d51a927226a7 |
| Bucket | 否 | String | COS存储桶，详见产品支持的存储桶命名规范。 示例值：examplebucket-1250000000 |
| Prefix | 否 | String | 投递规则投递的新的目录前缀。 - 仅支持0-9A-Za-z-_/ - 最大支持256个字符 示例值：var/xxx |
| Status | 否 | Boolean | 投递规则的开关状态。true：开启投递任务；false：关闭投递任务。 示例值：true |
| ShipperName | 否 | String | 投递规则的名字 示例值：testShipper |
| Interval | 否 | Integer | 投递的时间间隔，单位 秒，默认300，范围 300-900 示例值：300 |
| MaxSize | 否 | Integer | 投递的文件的最大值，单位 MB，默认256，范围 5-256 示例值：256 |
| FilterRules.N | 否 | Array of FilterRuleInfo | 投递日志的过滤规则，匹配的日志进行投递，各rule之间是and关系，最多5个，数组为空则表示不过滤而全部投递 |
| Partition | 否 | String | 投递日志的分区规则，支持strftime的时间格式表示 示例值：%Y%m%d |
| Compress | 否 | CompressInfo | 投递日志的压缩配置 |
| Content | 否 | ContentInfo | 投递日志的内容格式配置 |
| FilenameMode | 否 | Integer | 投递文件命名配置，0：随机数命名，1：投递时间命名。 示例值：0 |
| StorageType | 否 | String | cos桶存储类型。支持：STANDARD_IA、ARCHIVE、DEEP_ARCHIVE、STANDARD、MAZ_STANDARD、MAZ_STANDARD_IA、INTELLIGENT_TIERING。 1. STANDARD_IA：低频存储； 2. ARCHIVE：归档存储； 3. DEEP_ARCHIVE：深度归档存储； 4. STANDARD：标准存储； 5. MAZ_STANDARD：标准存储（多 AZ）； 6. MAZ_STANDARD_IA：低频存储（多 AZ）； 7. INTELLIGENT_TIERING：智能分层存储。 示例值：STANDARD |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改投递COS任务
修改投递COS任务
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyShipper
<公共请求参数>
{
"ShipperId": "2ac8a8aa-xxxx-xxxx-84cd-8cd2beeeae17",
"Bucket": "bucket-test-12541111",
"Prefix": "bow-test-12541111",
"ShipperName": "bow-test-shipper-12541111",
"Interval": 300,
"MaxSize": 5,
"FilenameMode": 1,
"FilterRules": [
{
"Key": "http",
"Regex": "^(\\d+\\.\\d+)\\..*",
"Value": "172.16"
}
],
"Partition": "/%Y/%m/%d/%H/",
"Compress": {
"Format": "none"
},
"Content": {
"Format": "json",
"Json": {
"EnableTag": true,
"MetaFields": [
"__SOURCE__",
"__FILENAME__",
"__TIMESTAMP__",
"__HOSTNAME__"
],
"JsonType": 1
}
}
}输出示例
{
"Response": {
"RequestId": "6ef60bec-xxxx-xxxx-bb20-270359fb54a7"
}
}示例2 修改投递任务
改为跨账号投递
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyShipper
<公共请求参数>
{
"ShipperId": "3f9562a7-xxxx-xxxx-b32a-d51a927226a7",
"Bucket": "examplebucket-1250000000",
"Prefix": "bowtest-1250000000",
"ShipperName": "bow-test-1250000000",
"Interval": 300,
"MaxSize": 10,
"FilenameMode": 1,
"FilterRules": [
{
"Key": "http",
"Regex": "^(\\d+\\.\\d+)\\..*",
"Value": "172.16"
}
],
"Partition": "/%Y/%m/%d/%H/",
"Compress": {
"Format": "gzip"
},
"Content": {
"Format": "json",
"Json": {
"EnableTag": true,
"MetaFields": [
"__SOURCE__",
"__FILENAME__",
"__TIMESTAMP__",
"__HOSTNAME__"
],
"JsonType": 0
}
}
}输出示例
{
"Response": {
"RequestId": "25d826d2-xxxx-xxxx-a4b6-f5490e86ae81"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| OperationDenied.ACLFailed | ACL校验失败。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountNotExists | 账户不存在。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.ShipperNotExist | 投递规则不存在。 |
