开启实时消费 - CreatePipeConsumption
功能介绍
开启实时消费
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/siem/pipes/{pipe_id}/consumption
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
pipe_id |
是 |
String |
数据管道ID |
响应参数
状态码:201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
access_point |
String |
访问点地址 |
|
dataspace_id |
String |
数据空间ID |
|
pipe_id |
String |
管道ID |
|
pipe_name |
String |
管道名称 |
|
status |
String |
管道状态 |
|
subscription |
String |
订阅ID |
|
type |
String |
管道类型 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
{
"pipe_id" : "b22106ba-bede-453c-8488-b60c70bd6aed"
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
成功 |
|
400 |
错误响应 |
错误码
请参见错误码。