说明:当前页面接口为旧版 API,未来可能停止维护。容器服务 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 容器服务 API 3.0。
接口描述
本接口 (GetLogCollector ) 用于获取已经创建的日志收集规则。
接口请求域名:
ccs.api.qcloud.com
输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数。
参数名称 | 描述 | 类型 | 必选 |
---|---|---|---|
name | 收集规则名称 | String | 是 |
clusterId | 集群 ID | String | 是 |
输出参数
参数名称 | 描述 | 类型 |
---|---|---|
code | 公共错误码。0 表示成功,其他值表示失败 | Int |
codeDesc | 业务错误码。成功时返回 Success,错误时返回具体业务错误原因 | String |
message | 模块错误信息描述,与接口相关 | String |
data | 日志收集规则相关数据 | Object |
data 字段的结构如下
参数名称 | 描述 | 类型 |
---|---|---|
logCollectorList | 日志收集规则 | Object |
logCollectorList 字段中 Object 的结构如下
参数名称 | 描述 | 类型 |
---|---|---|
name | 收集规则名称,集群范围内唯一,不可重复 | String |
clusterId | 集群 iID | 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=GetLogCollector&SecretId=1
&Nonce=30674
&Timestamp=1520305740
&Region=xx
&Uin=xxxxxxxxxx
&AppId=xxxxxxxxxx
&name=test-log
&clusterId=cls-xxxxxxxx
&Signature=tTpgwZlrdOEt%2BRaGFZ9941uiUO4%3D
输出
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": {
"logCollectorList": {
"name": "test-log",
"clusterId": "cls-xxxxxxxx",
"clusterName": "log-test",
"createdAt": "2018-03-06 11:07:59",
"inputType": "container-log",
"outputType": "kafka",
"inputOption": {
"allNamespaces": true
},
"outputOption": {
"host": "192.168.5.6",
"port": 13001,
"topic": "containerlogs"
}
}
}
}