开启日志备份或日志采集功能

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

账户的项目ID。

默认取值：

不涉及

cluster_id

是

String

参数解释：

指定开启日志备份或日志采集的集群ID。获取方法请参见获取集群ID。

约束限制：

不涉及

取值范围：

集群ID。

默认取值：

不涉及

action

否

String

参数解释：

配置集群开启日志备份或者日志采集。

约束限制：

不涉及

取值范围：

• base_log_collect：开启日志备份。

• real_time_log_collect：开启日志采集。

默认取值：

base_log_collect

agency

否

String

参数解释：

委托名称，快照数据存储到OBS桶中，需要OBS的操作权限。选择IAM委托，授权当前账号访问和使用OBS的权限。

约束限制：

当query参数action为base_log_collect时，需要填写该参数。

取值范围：

无法配置含特殊字符和中文字符的委托，允许使用的委托名称仅可包含a-zA-Z0-9-_字符。

默认取值：

不涉及

log_base_path

否

String

参数解释：

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

约束限制：

当query参数action为base_log_collect时，需要填写该参数。

取值范围：

• 备份路径不能包括下列符号 ：\:*?"<>|'{}

• 备份路径不能以“/”开头

• 备份路径不能以“.”开头或结尾

• 备份路径不能包含两个以上连续的斜杆（/）或点（.）

• 备份路径的总长度不能超过512字符。

默认取值：

不涉及

log_bucket

否

String

参数解释：

设置日志备份在OBS中的桶名。

约束限制：

当query参数action为base_log_collect时，需要填写该参数。

取值范围：

不涉及

默认取值：

不涉及

auto_enable

否

Boolean

参数解释：

集群日志是否开启自动备份。

约束限制：

当参数action为base_log_collect时，参数auto_enable有效。

取值范围：

• true：集群日志开启自动备份。

• false：集群日志不开启自动备份。

默认取值：

false

period

否

String

参数解释：

集群日志备份开始时间。

约束限制：

当参数action为base_log_collect且参数auto_enable为true时，该参数必填。

取值范围：

格式：格林威治标准时间（GMT）。比如：00:00 GMT+08:00。

默认取值：

不涉及

index_prefix

否

String

参数解释：

采集日志的索引前缀名称。设置后采集的日志索引名称为“索引前缀名称+日志采集日期”，日志采集日期以天为单位。

约束限制：

当query参数action为real_time_log_collect时，需要填写该参数。

取值范围：

索引名称只能包含数字、小写字母、下划线、中划线，长度1-128个字符。

默认取值：

不涉及

keep_days

否

Integer

参数解释：

采集日志的保留周期。当采集的日志超过保存周期时，日志将会被删除。

约束限制：

当query参数action为real_time_log_collect时，需要填写该参数。

取值范围：

1-3650

默认取值：

不涉及

target_cluster_id

否

String

参数解释：

设置保存日志的目标集群ID。

约束限制：

• 当query参数action为real_time_log_collect时，需要填写该参数。

• 目标集群可以是本集群，也可以是其他集群。选择采集到其他集群时，需要通过连通性测试接口来判断该集群是否可以作为目标集群，如果状态码返回的是200，则表示该集群可以作为保存日志的目标集群，否则，表示该集群不能作为保存日志的目标集群。

取值范围：

不涉及

默认取值：

不涉及

200

请求已成功。

400

非法请求。

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

409

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

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

412

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