5587b8e17d
Added notifications sent to API consumers by the VNF Fault Management and VNF Performance Management features to the API Reference. Added the following APIs: - alarm notification - AlarmClearedNotification - PerformanceInformationAvailableNotification - ThresholdCrossedNotification - Test the notification endpoint Change-Id: I5f169809c14bc980c8e2b37f1b49299cfa62086f Signed-off-by: Yasufumi Ogawa <yasufum.o@gmail.com> Co-Authored-By: Yoshiro Watanabe <fj3838ct@fujitsu.com>
106 lines
3.5 KiB
YAML
106 lines
3.5 KiB
YAML
#################
|
|
# Success Codes #
|
|
#################
|
|
200:
|
|
default: |
|
|
Request was successful.
|
|
201:
|
|
default: |
|
|
Resource was created and is ready to use.
|
|
202:
|
|
default: |
|
|
Request was accepted for processing, but the processing has not been
|
|
completed. A 'location' header is included in the response which contains
|
|
a link to check the progress of the request.
|
|
204:
|
|
default: |
|
|
The server has fulfilled the request by deleting the resource.
|
|
notification: |
|
|
The notification has been delivered successfully.
|
|
206:
|
|
default: |
|
|
Partial Content, The server has fulfilled the partial GET request for the
|
|
resource.
|
|
300:
|
|
default: |
|
|
There are multiple choices for resources. The request has to be more
|
|
specific to successfully retrieve one of these resources.
|
|
302:
|
|
default: |
|
|
The response is about a redirection hint. The header of the response
|
|
usually contains a 'location' value where requesters can check to track
|
|
the real location of the resource.
|
|
303:
|
|
default: |
|
|
The server is redirecting the user agent to a different resource, as indicated
|
|
by a URI in the Location header field, which is intended to provide an indirect
|
|
response to the original request.
|
|
|
|
#################
|
|
# Error Codes #
|
|
#################
|
|
|
|
400:
|
|
default: |
|
|
Some content in the request was invalid.
|
|
resource_signal: |
|
|
The target resource doesn't support receiving a signal.
|
|
401:
|
|
default: |
|
|
User must authenticate before making a request.
|
|
403:
|
|
default: |
|
|
Policy does not allow current user to do this operation.
|
|
404:
|
|
default: |
|
|
The requested resource could not be found.
|
|
fault_notification: |
|
|
The fault notification API is not enabled.
|
|
(CONF.server_notification.server_notification)
|
|
prometheus_plugin_pm: |
|
|
The Prometheus Plugin API is not enabled.
|
|
(CONF.prometheus_plugin.performance_management)
|
|
prometheus_plugin_fm: |
|
|
The Prometheus Plugin API is not enabled.
|
|
(CONF.prometheus_plugin.fault_management)
|
|
prometheus_plugin_auto_scale: |
|
|
The Prometheus Plugin API is not enabled.
|
|
(CONF.prometheus_plugin.auto_scaling)
|
|
prometheus_plugin_auto_heal: |
|
|
The Prometheus Plugin API is not enabled.
|
|
(CONF.prometheus_plugin.auto_healing)
|
|
405:
|
|
default: |
|
|
Method is not valid for this endpoint.
|
|
406:
|
|
default: |
|
|
Not Acceptable, the requested resource is only capable of generating
|
|
content not acceptable according to the 'Accept' headers sent in the
|
|
request.
|
|
409:
|
|
default: |
|
|
This operation conflicted with another operation on this resource.
|
|
duplicate_zone: |
|
|
There is already a zone with this name.
|
|
416:
|
|
default: |
|
|
Requested Range Not Satisfiable, A server SHOULD return a response with
|
|
this status code if a request included a Range request-header field,
|
|
and none of the range-specifier values in this field overlap the current
|
|
extent of the selected resource, and the request did not include an
|
|
If-Range request-header field.
|
|
422:
|
|
default: |
|
|
The content type of the payload body is supported and the payload body of a
|
|
request contains syntactically correct data (e.g. well-formed JSON) but the
|
|
data cannot be processed (e.g. because it fails validation against a schema).
|
|
500:
|
|
default: |
|
|
Something went wrong inside the service. This should not happen usually.
|
|
If it does happen, it means the server has experienced some serious
|
|
problems.
|
|
503:
|
|
default: |
|
|
Service is not available. This is mostly caused by service configuration
|
|
errors which prevents the service from successful start up.
|