获取日志主题列表

最近更新时间:2019-06-11 14:53:26

功能描述

本接口用于获取日志主题信息列表。

请求

请求示例

GET /topics?logset_id=xxxx-xx-xx-xx-xxxxxxxx HTTP/1.1
Host: <Region>.cls.myqcloud.com
Authorization: <AuthorizationString>

请求行

GET /topics

请求头

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

请求参数

字段名 类型 位置 是否必须 含义
logset_id string query 查询的 logset id

响应

响应示例

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

{
    "topics": [{
        "logset_id": "xxxx-xx-xx-xx-xxxxxxxx",
        "topic_id": "xxxx-xx-xx-xx-yyyyyyyy",
        "topic_name": "testname",
        "path": "/abc/log/test.log",
        "wild_path": "/data/nginx/log/**/access.log",
        "collection": true,
        "index": true,
        "log_type": "delimiter_log",
        "extract_rule": {
            "time_key": "date",
            "time_format": "%Y-%m-%d %H:%M:%S",
            "delimiter": "|",
            "log_regex": ".*",
            "beginning_regex": "^",
            "keys": ["date", "", "content"],
            "filter_keys": [],
            "filter_regex": []
        },
        "assumer_uin": "xxxxxxxxxxxx",
        "assumer_name": "xxxxxx",
        "topic_modify_acl": 31,
        "topic_show_acl": 31,
        "create_time": "2017-08-08 12:12:12"
    }]
}

响应头

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

响应参数

字段名 类型 是否必须 含义
topics JsonArray 日志主题信息数组

TopicInfo 格式如下:

字段名 类型 是否必须 含义
logset_id string 日志集的 ID
topic_id string 日志主题的 ID
topic_name string 日志主题的名字
path string 旧版日志文件路径
wild_path string 新版通配符日志采集路径,以/**/分隔文件目录和文件名,和旧版 path 只会存在一个
collection bool 是否开启采集
index bool 是否开启索引
log_type string 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表极简日志,egex_logmultiline_log代表多行日志,fullregex_log代表完整正则
extract_rule JsonObject 提取规则
machine_group JsonObject 采集机器组信息
assumer_uin int 创建主题的服务的 uin(仅普通账号查看服务账号创建的主题,才有此字段)
assumer_name string 创建主题的服务的名称(仅普通账号查看服务账号创建的主题,才有此字段)
topic_modify_acl int 普通用户对主题的修改权限 modify_acl(0B00000=禁止修改,0B00001=允许修改基本信息,0B00010=允许修改采集信息,0B00100=允许修改索引信息,0B01000=允许修改投递信息,0B10000=允许修改消费信息)(仅普通账号查看服务账号创建的主题,才有此字段)
topic_show_acl int 主题展示给普通用户的权限 show_acl(0B00000=全部不展示,0B00001=展示基本信息,0B00010=展示采集信息,0B00100=展示索引信息,0B01000=展示投递信息,0B10000=展示消费信息)
create_time string 创建时间

extract_rule 格式如下:

字段名 类型 是否必须 含义
time_key string 时间字段的 key 名字
time_format string 时间字段的格式,参考 C 语言的strftime函数对于时间的格式说明
delimiter string 分隔符类型日志的分隔符
log_regex string 多行日志类型的 整条日志匹配规则
beginning_regex string 多行日志类型的行首匹配规则
keys JsonArray(string) 提取的每个字段的 key 名字
filter_keys JsonArray(string) 需要过滤日志的 key
filter_regex JsonArray(string) 上述字段 filter_keys 对应的值,个数与 filter_keys 相同,一一对应

错误码

参见 错误码