更新时间：2025-11-21 GMT+08:00
获取实时消费配置 - ShowPipeConsumption
功能介绍
获取实时消费配置
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
GET /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 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
access_point |
String |
接入点域名信息(格式：{dataspace}.{endpoint}) |
|
pipe_name |
String |
数据管道名称 |
|
status |
String |
实时消费的开关状态；enable-开启，disable-关闭 |
|
subscription_name |
String |
订阅名称 |
|
table_id |
String |
表id |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
无
响应示例
状态码：200
成功
{
"access_point" : "dataspace01.isap.af-south-1.cloudsa.com",
"pipe_name" : "pipe-01",
"status" : "enable",
"subscription_name" : "test subscription"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功 |
|
400 |
错误响应 |
错误码
请参见错误码。
父主题： 数据管道
