文档中心>日志服务

获取投递配置

最近更新时间:2020-11-03 09:51:56

我的收藏

功能描述

本接口用于获取指定投递策略的详细信息。

请求

请求示例

GET /shipper?shipper_id=xxxx-xx-xx-xx-xxxxxxxx HTTP/1.1
Host: <Region>.cls.tencentyun.com
Authorization: <AuthorizationString>

请求行

GET /shipper

请求头

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

请求参数

字段名
类型
位置
是否必须
含义
shipper_id
string
query
查询的 shipper ID

响应

响应示例

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

{
"shipper_id": "xxxx-xx-xx-xx-xxxxxxxx",
"topic_id": "yyyy-yy-yy-yy-yyyyyyyy",
"bucket": "test-1250000001",
"prefix": "test",
"shipper_name": "myname",
"interval": 300,
"max_size": 100,
"effective": true,
"partition": "%Y%m%d",
"compress": {
"format": "none"
},
"content": {
"format": "json"
},
"create_time": "2017-12-12 12:12:12"
}

响应头

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

响应参数

字段名
类型
是否必须
含义
shipper_id
string
投递的 ID
topic_id
string
投递规则属于的 topic ID
bucket
string
投递的 bucket 地址
prefix
string
投递的前缀目录
shipper_name
string
投递规则的名字
interval
int
投递的时间间隔,单位秒
max_size
int
投递的文件的最大值,单位 MB
effective
bool
是否生效
create_time
string
投递日志的创建时间
partition
string
投递日志的分区规则,支持strftime的时间格式表示
compress
object
投递日志的压缩配置
content
object
投递日志的内容格式配置
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
对于上面指定的不存在字段使用该内容填充

错误码

参见 错误码