Obtaining the Data Pipeline List
Function
This API is used to obtain the data pipeline list.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/workspaces/{workspace_id}/siem/pipes
|
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. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
dataspace_id |
No |
String |
Data space ID. |
|
pipe_id |
Yes |
String |
Pipeline ID. |
|
pipe_name |
No |
String |
pipe name |
|
pipe_type |
No |
String |
Data pipeline type. The value can be system-defined or user-defined. |
|
offset |
No |
Long |
Page number. |
|
limit |
No |
Long |
Number of records on each page. |
|
sort_dir |
No |
String |
Sorting order. |
|
sort_key |
No |
String |
Sorting field. |
Request 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
|
Parameter |
Type |
Description |
|---|---|---|
|
count |
Long |
Quantity. |
|
records |
Array of Pipe objects |
Pipeline list. |
|
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
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Example Requests
None
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Successful. |
|
400 |
Error response. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot