修改数据管道 - UpdatePipe
功能介绍
修改数据管道
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
PUT /v1/{project_id}/workspaces/{workspace_id}/siem/pipes/{pipe_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取项目ID 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
workspace_id |
是 |
String |
工作空间ID |
|
pipe_id |
是 |
String |
管道ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取用户Token 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
description |
否 |
String |
描述 |
|
shards |
否 |
Integer |
分区个数；默认创建1个，最大支持创建10个分区 |
|
storage_period |
否 |
Integer |
数据的保存时间，单位为天；默认30天，取值范围为1~3600 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
create_by |
String |
创建者 |
|
create_time |
Long |
创建时间 |
|
dataspace_id |
String |
数据空间ID |
|
dataspace_name |
String |
数据空间名称 |
|
description |
String |
描述 |
|
domain_id |
String |
账号ID |
|
pipe_id |
String |
数据管道ID |
|
pipe_name |
String |
数据管道名称 |
|
pipe_type |
String |
数据管道类型；可选值：system-defined(系统预定义)、user-defined(用户自定义) |
|
project_id |
String |
项目ID |
|
shards |
Integer |
分区个数；默认创建1个，最大支持创建64个分区 |
|
storage_period |
Integer |
数据的保存时间，单位为天；默认30天，取值范围为1~3600 |
|
update_by |
String |
更新者 |
|
update_time |
Long |
更新时间 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
{
"description" : "test pipe",
"shards" : 3,
"storage_period" : 30
}
响应示例
状态码：200
成功
{
"create_by" : "0642ed520xxxxxxebedb6e57xxxxxxxx",
"create_time" : 1584883694354,
"dataspace_id" : "a00106ba-bede-453c-8488-b60c70bd6aed",
"dataspace_name" : "dataspace-01",
"description" : "test pipe",
"domain_id" : "0531ed520xxxxxxebedb6e57xxxxxxxx",
"pipe_id" : "b22106ba-bede-453c-8488-b60c70bd6aed",
"pipe_name" : "pipe-01",
"pipe_type" : "system-defined",
"project_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx",
"shards" : 3,
"storage_period" : 30,
"update_by" : "0642ed520xxxxxxebedb6e57xxxxxxxx",
"update_time" : 1584883694354
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功 |
|
400 |
错误响应 |
错误码
请参见错误码。
