Enabling Real-time Consumption
Function
Enabling Real-time Consumption
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/siem/pipes/{pipe_id}/consumption
|
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
|
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 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
pipe_id |
Yes |
String |
Data pipeline ID. |
Response Parameters
Status code: 201
|
Parameter |
Type |
Description |
|---|---|---|
|
access_point |
String |
Access URL. |
|
dataspace_id |
String |
Data space ID. |
|
pipe_id |
String |
Pipeline ID. |
|
pipe_name |
String |
Pipeline name. |
|
status |
String |
Pipeline status. |
|
subscription |
String |
Subscription ID. |
|
type |
String |
Pipeline type. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Example Requests
{
"pipe_id" : "b22106ba-bede-453c-8488-b60c70bd6aed"
}
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
201 |
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