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