列出日志收集规则

最近更新时间:2018-06-01 21:37:33

接口描述

本接口(ListLogCollector)用于获取某个集群中所有已经创建的日志收集规则。

接口请求域名:

ccs.api.qcloud.com

输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数

参数名称 描述 类型 必选
clusterId 集群 ID String
limit 返回的条目限制,默认为 20 Integer
offset 返回的条目偏移量,默认为 0 Integer

输出参数

参数名称 描述 类型
code 公共错误码。0 表示成功,其他值表示失败 Int
codeDesc 业务错误码。成功时返回 Success,错误时返回具体业务错误原因 String
message 模块错误信息描述,与接口相关 String
data 日志收集规则相关数据 Object

data 字段的结构如下:

参数名称 描述 类型
logCollectorList 日志收集规则列表 Array
totalCount 此集群中日志收集规则的总数目 Integer

logCollectorList 字段中每个 Object 的结构如下:

参数名称 描述 类型 必选
name 收集规则名称,集群范围内唯一,不可重复 String
clusterId 集群 ID String
clusterName 集群名称 String
createdAt 收集规则的创建时间 String
inputType 收集类型。“container-log”代表收集容器日志,“host-log”代表收集主机日志 String
outputType 消费类型。"kafka"代表输出到kafka,“ckafka”代表输出到ckafka String
inputOption 收集选项,参考 收集和消费选项 Object
outputOption 消费选项,参考 收集和消费选项 Object

示例

输入

https://ccs.api.qcloud.com/v2/index.php?Action=ListLogCollector
&SecretId=1
&Nonce=7784
&Timestamp=1520306248
&Region=xx
&Uin=xxxxxxxxxx
&AppId=xxxxxxxxxx
&name=test-log
&clusterId=cls-xxxxxxxx
&Signature=2YRbAxwy%2BlScil%2F%2FDa5otDHW4QI%3D

输出

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "logCollectorList": [
            {
                "name": "test-log",
                "clusterId": "cls-xxxxxxxx",
                "clusterName": "log-test",
                "createdAt": "2018-03-06 11:17:23",
                "inputType": "container-log",
                "outputType": "kafka",
                "inputOption": {
                    "allNamespaces": true
                },
                "outputOption": {
                    "host": "192.168.5.7",
                    "port": 13002,
                    "topic": "containerlogs"
                }
            }
        ],
        "totalCount": 1
    }
}