Modifying a Data Pipeline

Function

This API is used to modify a data pipeline.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/workspaces/{workspace_id}/siem/pipes/{pipe_id}

**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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
description	No	String	Description.
shards	No	Integer	Number of partitions. One partition is created by default. A maximum of 10 partitions can be created.
storage_period	No	Integer	Data storage duration, in days. The default value is 30. The value ranges from 1 to 3,600.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
create_by	String	Creator.
create_time	Long	Creation time.
dataspace_id	String	Data space ID.
dataspace_name	String	Data space name.
description	String	Description.
domain_id	String	Account ID.
pipe_id	String	Data pipeline ID.
pipe_name	String	Data pipeline name.
pipe_type	String	Data pipeline type. The value can be system-defined or user-defined.
project_id	String	Project ID.
shards	Integer	Number of partitions. One partition is created by default. A maximum of 64 partitions can be created.
storage_period	Integer	Data storage duration, in days. The default value is 30. The value ranges from 1 to 3,600.
update_by	String	Updater.
update_time	Long	Update time.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

{
  "description" : "test pipe",
  "shards" : 3,
  "storage_period" : 30
}

Example Responses

Status code: 200

Successful.

{
  "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
}