修改投递任务

最近更新时间:2018-12-13 21:34:41

功能描述

本接口可用于修改现有的投递任务,客户如果使用此接口,需要自行处理 CLS 对指定 Bucket 的写权限。

请求示例

 PUT /shipper HTTP/1.1
 Host: <Region>.cls.myqcloud.com
 Authorization: <AuthorizationString>
 Content-Type: application/json

 {
   "shipper_id": "xxxx-xx-xx-xx-xxxxxxxx",
   "bucket": "test-1250000001",
   "prefix": "test",
   "shipper_name": "myname",
   "interval": 300,
   "max_size": 256,
   "effective": true,
   "partition": "%Y%m%d",
     "compress": {
         "format": "none"
     },
     "content": {
         "format": "json",
     },
   "filter_rules": [{
     "key": "",
     "regex": "",
     "value": ""
   }]
 }

请求行

PUT /shipper

请求头

除公共头部外,无特殊请求头部。

请求参数

字段名 类型 位置 是否必须 含义
shipper_id string body 修改的 Shipper 的 ID
bucket string body Shipper 投递的新的 bucket,格式:{bucketName}-{appid}
prefix string body Shipper 投递的新的目录前缀
shipper_name string body 投递规则的名字
interval int body 投递的时间间隔,单位:秒,默认300,范围60 ~ 3600
max_size int body 投递的文件的最大值,单位:MB,默认256,范围100 ~ 10240
effective bool body Shipper 的开关状态
filter_rules array body 投递日志的过滤规则,匹配的日志进行投递,各 rule 之间是and关系,最多5个,数组为空则表示不过滤而全部投递
partition string body 投递日志的分区规则,支持strftime的时间格式表示
compress object body 投递日志的压缩配置
content object body 投递日志的内容格式配置

Rule 格式如下:

字段名 类型 是否必须 含义
key string 用来比较的 key,__CONTENT__代表全文
regex string 比较内容的提取正则表达式
value string 与上面 regex 提取出的内容比较的 value,如果一致则命中

compress 格式如下:

字段名 类型 是否必须 含义
format string 压缩格式,支持gziplzopnone不压缩

content 格式如下:

字段名 类型 是否必须 含义
format string 内容格式,支持jsoncsv
csv_info object 内容格式为csv时设置

csv_info 格式如下:

字段名 类型 是否必须 含义
print_key bool csv 首行是否打印 key
keys array(string) 每列 key 的名字
delimiter string 各字段间的分隔符
escape_char string 若字段内容中包含分隔符,则使用该转义符包裹改字段
non_existing_field string 对于上面指定的不存在字段使用该内容填充

注意:

其中 bucket、prefix、shipper_name、interval、max_size、effective、filter_rules、compress 字段至少要有一个。

响应

响应示例

 HTTP/1.1 200 OK
 Content-Type: application/json
 Content-Length: 0

响应头

除公共响应头部外,无特殊响应头部。

响应参数

错误码

参见 错误码