文档首页/ 云搜索服务 CSS/ API参考/ API V1/ Logstash/ 创建配置文件 - CreateConf
更新时间:2026-06-18 GMT+08:00
分享

创建配置文件 - CreateConf

功能介绍

该接口用于Logstash集群创建配置文件,该文件定义了Logstash集群的数据迁移方案。通过此配置文件,Logstash集群能够从多个数据源中提取数据,并将其迁移到指定的目的端。单集群最多创建50个配置文件。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    css:logstash:submitConf

    Write

    cluster *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/lgsconf/submit

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及

取值范围

账户的项目ID,长度为32个字符,由小写字母和数字组成。

默认取值

不涉及

cluster_id

String

参数解释

指定创建配置文件的集群ID。获取方法请参见获取集群ID

约束限制

UUID格式,36个字符。

取值范围

集群ID。

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释

配置文件名称。

约束限制

4~32个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。

取值范围

不涉及

默认取值

不涉及

conf_content

String

参数解释

配置文件内容。

约束限制

小于50KB

取值范围

不涉及

默认取值

不涉及

setting

setting object

参数解释

配置实体对象。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

sensitive_words

Array of strings

参数解释

敏感字符替换,输入需要隐藏的敏感字符串列表。配置隐藏字符串列表后,在返回的配置内容中,会将所有在列表中的字符串隐藏为***。

约束限制

列表最大支持20条,单个字符串最大长度512字节。

取值范围

不涉及

默认取值

不涉及

desc

String

参数解释

配置文件描述。

约束限制

不超过128个字符。

取值范围

不涉及

默认取值

不涉及

表3 setting

参数

是否必选

参数类型

描述

workers

Integer

参数解释

并行执行管道的Filters+Outputs阶段的工作线程数。

约束限制

不涉及

取值范围

1-节点CPU核数的5倍

默认取值

CPU核数。

batch_size

Integer

参数解释

单个工作线程在尝试执行其Filters和Outputs之前将从inputs收集的最大事件数,该值较大通常更有效,但会增加内存开销。

约束限制

不涉及

取值范围

1-100000

默认取值

125

batch_delay_ms

Integer

参数解释

每个event被pipeline调度等待的最小时间。单位毫秒。

约束限制

不涉及

取值范围

1-600000

默认取值

50

queue_type

String

参数解释

用于事件缓冲的内部队列模型。

约束限制

不涉及

取值范围

  • memory:基于内存的传统队列。

  • persisted:基于磁盘的ACKed持久化队列。

默认取值

不涉及

queue_check_point_writes

Integer

参数解释

如果使用持久化队列,则表示强制执行检查点之前写入的最大事件数。

约束限制

仅当queue_type=persisted时生效。

取值范围

1-40960

默认取值

1024

queue_max_bytes_mb

Integer

参数解释

如果使用持久化队列,则表示持久化队列的总容量(以兆字节MB为单位),确保磁盘的容量大于该值。

约束限制

仅当queue_type=persisted时生效

取值范围

1-100000

默认取值

1024

响应参数

状态码:200

请求成功。

请求示例

配置实体对象。

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/lgsconf/submit

{
  "name" : "conf",
  "desc" : "This is a description of a configuration file.",
  "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

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

错误码

请参见错误码

相关文档