更新时间:2024-10-17 GMT+08:00

修改日志基础配置

功能介绍

该接口用于修改日志基础配置。

调试

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

URI

POST /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,兼容之前的逻辑

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

agency

String

委托名称,委托给CSS,允许CSS调用您的其他云服务。action不等于real_time_log_collect时必填。

logBasePath

String

日志在OBS桶中的备份路径。action不等于real_time_log_collect时必填。

logBucket

String

用于存储日志的OBS桶的桶名。action不等于real_time_log_collect时必填。

index_prefix

String

日志保存的索引前缀。action等于real_time_log_collect时必填。

keep_days

Integer

日志保存时间。action等于real_time_log_collect时必填。

target_cluster_id

String

保存日志的目标集群。action等于real_time_log_collect时必填。

响应参数

请求示例

  • 修改日志基础配置。

    POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/settings
    
    {
      "agency" : "css_obs_agency",
      "logBasePath" : "css/log",
      "logBucket" : "000-words"
    }
  • 更新日志实时采集配置

    POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/settings?action=real_time_log_collect 
    
    {
      "index_prefix" : "css_log",
      "keep_days" : 30,
      "target_cluster_id" : "4f3deec3-efa8-4598-bf91-560aad1377a3",
    }

响应示例

状态码

状态码

描述

200

请求已成功。

400

非法请求。

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

409

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

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

412

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

错误码

请参见错误码