创建配置文件
功能介绍
该接口用于生成配置文件,该文件定义了Logstash集群的数据迁移方案。通过此配置文件,Logstash集群能够从多个数据源中提取数据,并将其迁移到指定的目的端。单集群最多创建50个配置文件。
调用方法
请参见如何调用API。
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/lgsconf/submit
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
参数解释: 配置文件名称。 约束限制: 不涉及 取值范围: 4~32个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
|
conf_content |
是 |
String |
参数解释: 配置文件内容。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
setting |
是 |
setting object |
参数解释: 配置实体对象。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
sensitive_words |
否 |
Array of strings |
参数解释: 敏感字符替换,输入需要隐藏的敏感字符串列表。配置隐藏字符串列表后,在返回的配置内容中,会将所有在列表中的字符串隐藏为***。 约束限制: 列表最大支持20条,单个字符串最大长度512字节。 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
workers |
否 |
Integer |
参数解释: 并行执行管道的Filters+Outputs阶段的工作线程数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: CPU核数。 |
|
batch_size |
否 |
Integer |
参数解释: 单个工作线程在尝试执行其Filters和Outputs之前将从inputs收集的最大事件数,该值较大通常更有效,但会增加内存开销。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 125 |
|
batch_delay_ms |
否 |
Integer |
参数解释: 每个event被pipeline调度等待的最小时间。单位毫秒。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
queue_type |
是 |
String |
参数解释: 用于事件缓冲的内部队列模型。 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
|
queue_check_point_writes |
否 |
Integer |
参数解释: 如果使用持久化队列,则表示强制执行检查点之前写入的最大事件数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 1024 |
|
queue_max_bytes_mb |
否 |
Integer |
参数解释: 如果使用持久化队列,则表示持久化队列的总容量(以兆字节MB为单位),确保磁盘的容量大于该值。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 1024 |
响应参数
状态码:200
请求已成功。
无
请求示例
配置实体对象。
POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/lgsconf/submit
{
"name" : "conf1",
"conf_content" : "xxxxxxxx",
"setting" : {
"workers" : 2,
"batch_size" : 125,
"batch_delay_ms" : 50,
"queue_type" : "persisted",
"queue_check_point_writes" : 1024,
"queue_max_bytes_mb" : 1024
}
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功。 |
|
400 |
非法请求。 建议直接修改该请求,不要重试该请求。 |
|
409 |
服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 |
|
412 |
未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 |
错误码
请参见错误码。