File: dns-api-v2-service-status.inc

package info (click to toggle)
designate 1%3A21.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,860 kB
  • sloc: python: 49,608; sh: 1,914; sql: 155; makefile: 83; javascript: 3
file content (118 lines) | stat: -rw-r--r-- 2,185 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
================
Service Statuses
================

The Service Status entries are used to track the health state of the services
in the Designate system. Each service will report in it's health via RPC or
using HTTP.


List Statuses
=============

.. rest_method::  GET /v2/service_statuses

List all Services and statuses.


.. rest_status_code:: success status.yaml

    - 200

.. rest_status_code:: error status.yaml

    - 400
    - 401
    - 403
    - 404
    - 405
    - 503

Request Parameters
------------------

.. rest_parameters:: parameters.yaml

   - x-auth-token: x-auth-token
   - x-auth-all-projects: x-auth-all-projects
   - x-auth-sudo-project-id: x-auth-sudo-project-id


Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - x-openstack-request-id: x-openstack-request-id
   - capabilities: capabilities
   - created_at: created_at
   - heartbeated_at: heartbeated_at
   - hostname: hostname
   - id: id
   - links: links
   - service_name: service_name
   - service_statuses: service_statuses
   - stats: stats
   - status: status
   - updated_at: updated_at


Response Example
----------------

.. literalinclude:: samples/service_status/service_status_list.json
   :language: javascript

Show a Service Status
=====================

.. rest_method::  GET /v2/service_statuses/{service_id}

Show the status of a service.


.. rest_status_code:: success status.yaml

    - 200

.. rest_status_code:: error status.yaml

    - 400
    - 401
    - 403
    - 404
    - 405
    - 503

Request Parameters
------------------

.. rest_parameters:: parameters.yaml

   - service_id: path_service_id
   - x-auth-token: x-auth-token


Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - x-openstack-request-id: x-openstack-request-id
   - capabilities: capabilities
   - created_at: created_at
   - heartbeated_at: heartbeated_at
   - hostname: hostname
   - id: id
   - links: links
   - service_name: service_name
   - stats: stats
   - status: status
   - updated_at: updated_at


Response Example
----------------

.. literalinclude:: samples/service_status/service_status_show.json
   :language: javascript