Hasko, Vladimir bbf8757cdf AOM API 0929 (recreate of #275 )

Reviewed-by: gtema <artem.goncharov@gmail.com>
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>

2022-11-29 12:44:31 +00:00

16 KiB

Raw Blame History

Deleting a Threshold Rule

Function

This API is used to delete a threshold rule.

URI

DELETE /v2/{project_id}/ams/alarms/{alarm_id}

Request

Request parameters

Table 1 describes the request parameters.

**Table 1** Request parameters
Parameter	Mandatory	Type	Value Range	Description
project_id	Yes	String	-	Project ID obtained from IAM. Generally, a project ID contains 32 characters.
alarm_id	Yes	String	Non-null value that can be converted to a value of the long type.	Threshold rule ID.

Request headers

Table 2 describes the request headers.

**Table 2** Request headers
Name	Mandatory	Description
X-Auth-Token	Yes	User token obtained from IAM.
Content-Type	Yes	Content type, which is application/json.

Example request

/v2/{project_id}/ams/alarms/al1441967036681YkazZ0deN

Response

Response parameters

Table 3 describes the response parameters.

**Table 3** Response parameters
Parameter	Type	Description
errorCode	String	Response code.
errorMessage	String	Response message.

Example response

{  
 "errorCode": "AOM.0200", 
 "errorMessage": "Delete Threshold [xxx] successfully ." 
}

Status Code

Success response
Table 4 describes the status code.

Table 4 Status code
Status Code

Message

Description

200

OK

The request has succeeded.

**Table 4** Status code
Status Code	Message	Description
200	OK	The request has succeeded.

Error response

Table 5 describes the status codes. For more information, see Status Codes.

**Table 5** Status codes
Status Code	Message	Description
400	Bad Request	The request is invalid. The client should not repeat the request without modifications.
401	Unauthorized	The authorization information provided by the client is incorrect or invalid.
403	Forbidden	The request is rejected. The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications.
500	Internal Server Error	The server is able to receive the request but unable to understand the request.
503	Service Unavailable	The requested service is invalid. The client should not repeat the request without modifications.

Error Code

**Table 6** Error codes
Error Code	Message	Solution
AOM.0115	Invalid request parameter.	Check whether the parameter meets requirements.
AOM.0501	The Cassandra session is null.	Contact technical support.
AOM.0502	The Cassandra execution is abnormal.	Contact technical support.

Parent topic: Monitoring APIs

16 KiB Raw Blame History