Help Center/ SecMaster/ API Reference/ Security Analysis V2 APIs/ Data Consumption Management/ Enabling Real-time Consumption
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Enabling Real-time Consumption

Function

This API is used to enable real-time consumption.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/workspaces/{workspace_id}/siem/tables/{table_id}/consumption

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Workspace ID.

table_id

Yes

String

Table ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

table_name

String

Table name.

dataspace_id

String

Data space ID.

pipe_id

String

Pipeline ID.

pipe_name

String

Pipe name

status

String

Definition

Status.

  • ENABLED

  • DISABLED

Constraints

N/A

Range

  • ENABLED

  • DISABLED

Default Value

N/A

type

String

Definition

Network type.

  • INTERNET: Internet

  • INTRANET intranet

Constraints

N/A

Range

  • INTERNET

  • INTRANET

Default Value

N/A

access_point

String

Domain name of the access point. Format: {dataspace}.{endpoint}.

subscirption

String

Subscription name.

table_id

String

Table ID.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Error response

Error Codes

See Error Codes.