Updated on 2025-12-18 GMT+08:00

Disabling Real-Time Consumption

Function

This API is used to disable real-time consumption.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/{project_id}/workspaces/{workspace_id}/siem/pipes/{pipe_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

Value Range

N/A

Default value

N/A

workspace_id

Yes

String

Workspace ID.

pipe_id

Yes

String

Pipeline 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

access_point

String

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

pipe_name

String

Data pipeline name.

status

String

Status of the real-time data consumption, which can be enabled or disabled.

subscription_name

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 message.

Example Requests

None

Example Responses

Status code: 200

Successful.

{
  "access_point" : null,
  "pipe_name" : null,
  "status" : "disable",
  "subscription_name" : null
}

Status Codes

Status Code

Description

200

Successful.

400

Error response.

Error Codes

See Error Codes.