查询日志基础配置
功能介绍
该接口用于查询集群日志备份或日志实时采集的基础配置。如果集群打开过日志备份或者日志采集的功能开关,那可以通过该接口分别查询日志备份的基础配置和日志采集的基础配置。
调用方法
请参见如何调用API。
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/logs/settings
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID和名称。 约束限制: 不涉及 取值范围: 账户的项目ID。 默认取值: 不涉及 |
|
cluster_id |
是 |
String |
参数解释: 指定查询集群ID。获取方法请参见获取集群ID。 约束限制: 不涉及 取值范围: 集群ID。 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
action |
否 |
String |
参数解释: 查询集群日志备份或者日志采集的配置。 约束限制: 不涉及 取值范围:
默认取值: base_log_collect |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
logConfiguration |
logConfiguration object |
参数解释: 日志备份的配置。 取值范围: 不涉及 |
|
realTimeLogCollectRecord |
realTimeLogCollect object |
参数解释: 日志实时采集的配置。 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 日志备份ID,通过系统UUID生成。 取值范围: 不涉及 |
|
clusterId |
String |
参数解释: 集群ID。 取值范围: 不涉及 |
|
obsBucket |
String |
参数解释: 用于存储日志的OBS桶的桶名。 取值范围: 不涉及 |
|
agency |
String |
参数解释: 委托名称,委托给CSS,允许CSS调用您的其他云服务。无法配置含特殊字符和中文字符的委托。 取值范围: 允许使用的委托名称仅可包含a-zA-Z0-9-_字符。 |
|
updateAt |
Long |
参数解释: 更新时间。 取值范围: 格式为ISO8601:CCYY-MM-DDThh:mm:ss。 |
|
basePath |
String |
参数解释: 日志在OBS桶中的备份路径。 取值范围: 不涉及 |
|
autoEnable |
Boolean |
参数解释: 是否开启自动备份开关。 取值范围:
|
|
period |
String |
参数解释: 自动备份日志开始时间。 取值范围: 格式为:格林威治标准时间(GMT)。当autoEnable为false时该字段为null。 |
|
logSwitch |
Boolean |
参数解释: 是否开启日志开关。 取值范围:
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 日志采集ID,通过系统UUID生成。 取值范围: 不涉及 |
|
clusterId |
String |
参数解释: 集群ID。 取值范围: 不涉及 |
|
indexPrefix |
String |
参数解释: 日志保存索引的前缀。 取值范围: 不涉及 |
|
keepDays |
Integer |
参数解释: 日志保存时间。 取值范围: 不涉及 |
|
targetClusterId |
String |
参数解释: 保存日志的目标集群ID。 取值范围: 不涉及 |
|
status |
String |
参数解释: 日志实时采集任务状态。 取值范围:
|
|
createAt |
Long |
参数解释: 日志实时采集任务开启时间。 取值范围: 不涉及 |
|
updateAt |
Long |
参数解释: 日志实时采集任务更新时间。 取值范围: 不涉及 |
请求示例
-
查询集群日志备份的配置。
GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/logs/settings?action=base_log_collect -
查询集群日志实时采集的配置。
GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/logs/settings?action=real_time_log_collect
响应示例
状态码:200
请求已成功。
-
查询集群日志备份的配置响应示例。
{ "logConfiguration" : { "id" : "00032118-aff5-40e8-b19a-dd4bb576e572", "clusterId" : "e3201ceb-1a3e-49f3-bb2f-23a816440b20", "obsBucket" : "css-autobk-notdel-cn-north-7", "agency" : "css_obs_agency", "updateAt" : 1639624882000, "basePath" : "css/log", "autoEnable" : false, "period" : null, "logSwitch" : false }, "realTimeLogCollectRecord" : null } -
查询集群日志实时采集的配置响应示例。
{ "logConfiguration" : null, "realTimeLogCollectRecord" : { "id" : "17939b7b-5a93-4ca5-8d3c-b9f2d0e715b4", "clusterId" : "e3201ceb-1a3e-49f3-bb2f-23a816440b20", "keepDays" : 30, "updateAt" : 1717666418870, "createAt" : 1717666405897, "targetClusterId" : "8c19644b-f2ef-44fc-abef-230a4c578ce7", "indexPrefix" : "aaa", "status" : "200" } }
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功。 |
|
400 |
非法请求。 建议直接修改该请求,不要重试该请求。 |
|
409 |
服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 |
|
412 |
未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 |
错误码
请参见错误码。