Deleting an Alert
Function
This API is used to delete an alert.
Calling Method
For details, see Calling APIs.
URI
DELETE /v1/{project_id}/workspaces/{workspace_id}/soc/alerts
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
workspace_id |
Yes |
String |
Workspace ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
content-type |
Yes |
String |
Content type. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
batch_ids |
No |
Array of strings |
IDs of deleted alerts. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code. |
message |
String |
Error message. |
data |
BatchOperateAlertResult object |
Returned object for batch operation on alerts. |
Parameter |
Type |
Description |
---|---|---|
error_ids |
Array of strings |
Failed IDs. |
success_ids |
Array of strings |
Succeeded IDs. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code. |
message |
String |
Error description. |
Example Requests
Delete the alert whose ID is 909494e3-558e-46b6-a9eb-07a8e18ca621.
{ "batch_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ] }
Example Responses
Status code: 200
Response body of the request for deleting alerts.
{ "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "message" : "Error message", "data" : { "success_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ], "error_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ] } }
Status Codes
Status Code |
Description |
---|---|
200 |
Response body of the request for deleting alerts. |
400 |
Response body of the failed request for deleting alerts. |
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