创建投递规则
最近更新时间: 2024-10-18 10:38:38
1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
创建新的投递规则，客户如果使用此接口，需要自行处理CLS对指定bucket的写权限。
默认接口请求频率限制：20次/秒。
接口更新时间：2022-10-31 11:10:35。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateShipper |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| TopicId | 是 | 否 | String | 创建的投递规则所属的日志主题ID |
| Bucket | 是 | 否 | String | 创建的投递规则投递的bucket |
| Prefix | 是 | 否 | String | 创建的投递规则投递目录的前缀 |
| ShipperName | 是 | 否 | String | 投递规则的名字 |
| Interval | 否 | 否 | Uint64 | 投递的时间间隔，单位 秒，默认300，范围 300-900 |
| MaxSize | 否 | 否 | Uint64 | 投递的文件的最大值，单位 MB，默认256，范围 100-256 |
| FilterRules | 否 | 否 | Array of FilterRuleInfo | 投递日志的过滤规则，匹配的日志进行投递，各rule之间是and关系，最多5个，数组为空则表示不过滤而全部投递 |
| Partition | 否 | 否 | String | 投递日志的分区规则，支持strftime的时间格式表示 |
| Compress | 否 | 否 | CompressInfo | 投递日志的压缩配置 |
| Content | 否 | 否 | ContentInfo | 投递日志的内容格式配置 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ShipperId | String | 此参数对外不可见。 投递规则ID |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InvalidParameterValue | |
| MissingParameter | |
| InternalError | |
| FailedOperation | |
| AuthFailure | |
| OperationDenied | |
| ResourceNotFound.TopicNotExist | |
| OperationDenied.ACLFailed | |
| InvalidParameter.ShipperConflict | |
| LimitExceeded.Shipper | |
| OperationDenied.AccountIsolate | |
| OperationDenied.AccountDestroy | |
| OperationDenied.AccountNotExists |