文档首页/云日志服务 LTS/更多文档/API参考（安卡拉区域）/API说明/日志接入-旧版2.0/查询日志采集路径
更新时间：2024-04-12 GMT+08:00
查看PDF
分享

查询日志采集路径

功能介绍

该接口用于查询指定的ICAgent的日志采集路径。 该API只适用于应用运维管理（AOM）界面的日志 -> 日志路径中的日志采集路径的查询。

URI

GET /v3/{project_id}/log-paths

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见：获取账号ID、日志组ID、日志流ID。

最小长度：32

最大长度：32

表2 Query参数

参数

是否必选

参数类型

描述

id

否

String

查询指定的ICAgent日志采集路径，内容为由逗号分隔的ICAgent ID，如果不填默认为获取当前项目下的所有ICAgent的日志采集路径。

缺省值：获取所有ICAgent的日志采集路径。

最小长度：0

最大长度：35999

最小长度：0

最大长度：35999

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM获取的用户Token。

缺省值：None

最小长度：1000

最小长度：1000

最大长度：2000

Content-Type

是

String

该字段填为：application/json;charset=utf8。

缺省值：None

最小长度：29

最小长度：29

最大长度：29

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of AgentConfInfo1 objects

请求响应成功。查询日志采集路径成功。

表5 AgentConfInfo1

参数

参数类型

描述

agent_id

String

ICAgent的唯一ID。

log_paths

Array of strings

日志采集路径列表。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

errorCode

String

状态返回码。

errorMessage

String

调用该接口响应信息描述。

状态码： 401

表7 响应Body参数

参数

参数类型

描述

errorCode

String

状态返回码。

errorMessage

String

调用该接口响应信息描述。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

errorCode

String

状态返回码。

errorMessage

String

调用该接口响应信息描述。

状态码： 503

表9 响应Body参数

参数

参数类型

描述

errorCode

String

状态返回码。

errorMessage

String

调用该接口响应信息描述。

请求示例

GET https://{endpoint}/v3/${project_id}/log-paths?id=86072d0f-1580-4bbe-a467-66cf61767f80,79e86731- b22b-4207-ae1b-8de882ea3711

响应示例

状态码： 200

请求响应成功。查询日志采集路径成功。

[ {
  "agent_id" : "c44fd66b-4bf5-4424-8c13-a2bfc927f51c",
  "log_paths" : [ "/log/trace.log" ]
}, {
  "agent_id" : "c44fd66b-4bf5-4424-8c13-a2bfc927f51d",
  "log_paths" : [ "/log/trace.log" ]
} ]

状态码： 401

在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。

{
  "errorCode" : "SVCSTG.ALS.403.105",
  "errorMessage" : "Project id is invalid."
}

状态码

状态码

描述

200

请求响应成功。查询日志采集路径成功。

400

BadRequest。非法请求。建议根据error_msg直接修改该请求，不要重试该请求。

401

在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。

500

系统内部错误。

503

ServiceUnavailable。被请求的服务无效，服务不可用。

错误码

请参见错误码。