创建数据管道
功能介绍
创建数据管道
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/siem/pipes
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目id |
|
workspace_id |
是 |
String |
工作空间id |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
dataspace_id |
是 |
String |
工作空间ID |
|
pipe_name |
是 |
String |
数据管道名称 |
|
description |
否 |
String |
描述 |
|
storage_period |
是 |
Integer |
数据的保存时间，单位为天；默认30天，取值范围为1~3600 |
|
shards |
是 |
Integer |
数据管道分区个数；默认创建1个，最大支持创建64个分区 |
|
timestamp_field |
否 |
String |
时间戳字段 |
|
mapping |
否 |
Map<String,KeyIndex> |
索引字段映射；每个key对象承载一个字段的信息；存在多个key对象，key可变，表示字段名称；可嵌套 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
type |
否 |
String |
字段类型；text 全文索引字段、keyword 结构化字段、long Long、integer Integer、double Double、float Float、date 时间字段 |
|
is_chinese_exist |
否 |
Boolean |
是否包含中文 |
|
properties |
否 |
Map<String,KeyIndex> |
嵌套结构 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
domain_id |
String |
用户domainId |
|
project_id |
String |
项目id |
|
dataspace_id |
String |
数据空间id |
|
dataspace_name |
String |
数据空间名称 |
|
pipe_id |
String |
管道id |
|
pipe_name |
String |
管道名称 |
|
pipe_type |
String |
管道类型（system-defined，系统预定义)、1（user-defined，用户自定义) |
|
description |
String |
描述信息 |
|
storage_period |
Integer |
索引存储天数 |
|
shards |
Integer |
索引分片数量 |
|
create_by |
String |
创建者 |
|
create_time |
Integer |
创建时间 |
|
update_by |
String |
更新者 |
|
update_time |
Integer |
更新时间 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
无效请求提示信息 |
|
error_code |
String |
错误码 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
权限错误 |
|
error_code |
String |
错误码 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
无效请求提示信息 |
|
error_code |
String |
错误码 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
系统内部错误 |
|
error_code |
String |
错误码 |
请求示例
{
"dataspace_id" : "a00106ba-bede-453c-8488-b60c70bd6aed",
"pipe_name" : "pipe-01",
"description" : "test pipe",
"storage_period" : 30,
"shards" : 3,
"mapping" : {
"name" : {
"type" : "text"
},
"id" : {
"type" : "text"
},
"publish_time" : {
"type" : "data"
}
}
}
响应示例
状态码：200
创建成功返回值
{
"domain_id" : "0531ed520xxxxxxebedb6e57xxxxxxxx",
"project_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx",
"dataspace_id" : "a00106ba-bede-453c-8488-b60c70bd6aed",
"dataspace_name" : "dataspace-01",
"pipe_id" : "b22106ba-bede-453c-8488-b60c70bd6aed",
"pipe_name" : "pipe-01",
"pipe_type" : "system-defined",
"description" : "test pipe",
"storage_period" : 30,
"shards" : 3,
"create_by" : "0642ed520xxxxxxebedb6e57xxxxxxxx",
"create_time" : 1584883694354,
"update_by" : "0642ed520xxxxxxebedb6e57xxxxxxxx",
"update_time" : 1584883694354
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
创建成功返回值 |
|
400 |
错误请求 |
|
401 |
认证失败 |
|
403 |
访问拒绝 |
|
500 |
系统内部错误 |
错误码
请参见错误码。
