Endre Karlson 86c8233ea1 Fix example response for reports/tenant

Change-Id: I63042366e7d7c54c7422b7fb8218aa22c75e01c4

2014-09-22 18:35:17 +02:00

4.5 KiB

Raw Blame History

Reports

Overview

Note: Reports 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 = reports, ...

Reports about things in the system

Get all tenants

Fetch all tenants

Example request:
GET /reports/tenants 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

{
  "tenants": [{
      "domain_count": 2,
      "id": "71ee6d049a49435c8f7dd002cfe08d96"
  }]
}
form tenants

List of tenants

statuscode 200

Success

statuscode 401

Access Denied

Report tenant resources

Report tenant resources

Example request:
GET /reports/tenants/3d8391080d4a4ec4b3eadf18e6b1539a HTTP/1.1
Host: example.com
Accept: application/json
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "domain_count": 0,
    "domains": [],
    "id": "3d8391080d4a4ec4b3eadf18e6b1539a"
}
param tenant_id

Tenant Id to get reports for

type tenant_id

string

form domain_count

integer

form domains

Server hostname

form id

Tenant Id

statuscode 200

Success

statuscode 401

Access Denied

Report resource counts

Report resource counts

Example request:
GET /reports/counts HTTP/1.1
Host: example.com
Accept: application/json
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "domains": 0,
    "records": 0,
    "tenants": 0
}
form domains

Domains count

form records

Records count

form tenants

Tenants count

statuscode 200

Success

statuscode 401

Access Denied

Report tenant counts

Report tenant counts

Example request:
GET /reports/counts/tenants HTTP/1.1
Host: example.com
Accept: application/json
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "tenants": 0
}
form tenants

Tenants count

statuscode 200

Success

statuscode 401

Access Denied

Report domain counts

Report domain counts

Example request:
GET /reports/counts/domains HTTP/1.1
Host: example.com
Accept: application/json
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "domains": 0
}
form domains

Domains count

statuscode 200

Success

statuscode 401

Access Denied

Report record counts

Report record counts

Example request:
GET /reports/counts/records HTTP/1.1
Host: example.com
Accept: application/json
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "records": 0
}
form records

Records count

statuscode 200

Success

statuscode 401

Access Denied

4.5 KiB Raw Blame History