designate/doc/source/rest/v1/diagnostics.rst
Endre Karlson aa93c9dc7b Add v1 missing api docs
Change-Id: I65789f319093041b008b77e9c3dddb744de1a4e4
2014-09-22 00:47:00 +02:00

1.6 KiB

Diagnostics

Overview

Note: Diagnostics is an extension and needs to be enabled before it can be used. If Designate returns a 404 error, ensure that the following line has been added to the designate.conf file:

enabled_extensions_v1 = diagnostic, ...

Diagnose parts of the system.

Ping a host on a RPC topic

Ping a host on a RPC topic

Example request:

GET /diagnostics/ping/agents/msdns-1 HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "host": "rpc-hostname",
  "status": true,
  "backend": "msdns",
  "storage": {"status": true, "message": "..."}
}
statuscode 200

Success

statuscode 401

Access Denied