文档首页/ 云搜索服务 CSS/ API参考/ 日志管理接口/ 查询日志基础配置
更新时间：2024-10-17 GMT+08:00
查看PDF
分享

查询日志基础配置

功能介绍

该接口用于日志基础配置查询。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/logs/settings

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见获取项目ID和名称。

cluster_id

是

String

指定查询集群ID。
表2 Query参数

参数

是否必选

参数类型

描述

action

否

String

action支持base_log_collect和real_time_log_collect两种，base就是之前历史的能力，real_time为实时采集能力，默认不传就是base，兼容之前的逻辑

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

logConfiguration

logConfiguration object

日志配置实体对象。

realTimeLogCollectRecord

realTimeLogCollect object

日志实时采集配置。
表4 logConfiguration

参数

参数类型

描述

id

String

日志备份ID，通过系统UUID生成。

clusterId

String

集群ID。

obsBucket

String

用于存储日志的OBS桶的桶名。

agency

String

委托名称，委托给CSS，允许CSS调用您的其他云服务。

updateAt

Long

更新时间。格式为：Unix时间戳格式。

basePath

String

日志在OBS桶中的备份路径。

autoEnable

Boolean

自动备份开关。

  • true: 自动备份开启。

  • false: 自动备份关闭。

period

String

自动备份日志开始时间。当autoEnable为false时该字段为null。格式为：格林威治标准时间。

logSwitch

Boolean

日志开关。

  • true: 日志开启。

  • false: 日志关闭。
表5 realTimeLogCollect

参数

参数类型

描述

id

String

日志采集ID，通过系统UUID生成。

clusterId

String

集群id

indexPrefix

String

日志保存索引的前缀。

keepDays

Integer

日志保存时间。

targetClusterId

String

保存日志的目标集群ID。

status

String

日志实时采集任务状态。

createAt

Long

日志实时采集任务开启时间。

updateAt

Long

日志实时采集任务更新时间。

请求示例

无

响应示例

状态码： 200

请求已成功。

  • 日志实时采集响应示例。

    {
  "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"
  }
}

  • 日志备份响应示例。

    {
  "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
}

状态码

状态码

描述

200

请求已成功。

400

非法请求。

建议直接修改该请求，不要重试该请求。

409

服务器在完成请求时发生冲突。

返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。

412

未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。

错误码

请参见错误码。

父主题： 日志管理接口