Delete Alarm

Overview

  • Delete an alarm.
  • This API performs the same function as "OpenStack Telemetry API: DELETE /v2/alarms/{alarm_id}".

Classification

  • Delete

API Operation Object

  • Alarm

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • DELETE

HTTP Request Path

{api_endpoint}/v2/alarms/{alarm_id}

HTTP Request Header

Content-Type: application/json
Accept: application/json
X-Auth-Token: <token_id>

HTTP Request Body

  • none

Request Parameter

item style format description required/optional default value action for invalid parameter response code for invalid parameter
alarm_id Query String(UUID) The UUID of the alarm which you want to delete required - Terminate 401, 404

Response

Response Header

Format

HTTP/1.1 <response_code> <status>       (ex. 200 OK)
  • <response_code>: see "Response Code" section
  • <status>: message based on the response code

注釈

skip auto-insert fields such as "Content-Length" and "Date"

Response Code

response code status condition message
204 no content normal end  
401 unauthorized authentication failure The request you have made requires authentication.
404 not found invalid alarm id Target resource not found.
500 internal server error internal server error  

Response Body

  • none

Sample Request and Response

Sample API Request

Request URL

DELETE /v2/alarms/638c3bfe-9435-45f5-9fbb-9d6d380c17ba

Request Header

Content-Type: application/json
Accept: application/json
X-Auth-Token: e8c788fbaeb14964ae19759eb1df4ff1

Request Body

  • none

Sample API Response

Response Header

HTTP/1.1 204 No Content

Response Body

  • none

Sample Error Response

DELETE /v2/alarms/10f2b54e-4f31-4c18-b3c8-cc5b6be072ef
User-Agent: curl/7.19.7
Content-Type: application/json
Accept: application/json
X-Auth-Token: 61389973e52b49c394ba3b89179b290b

HTTP Response

HTTP/1.1 404 Not Found
Date: Mon, 09 Nov 2015 07:54:10 GMT
Server: Apache
Cache-Control: no-cache
X-XSS-Protection: 1; mode=block
X-Frame-Options: SAMEORIGIN
X-Content-Type-Options: nosniff
Status: 404 Not Found
Connection: close
Transfer-Encoding: chunked
Content-Type: application/json; charset=utf-8

{"error":{"code":404,"message":"Target resource not found.","title":"NotFound"}}