Retrieve Service Summary

post

/dhcs/management/api/v1/metrics/serviceSummary

This api retrieves aggregated service summary for a cassandra cluster

Request

Supported Media Types

• application/json

Body ()

Service Summary request

Root Schema : ServiceSummaryRequest

Type: object

Show Source

• cluster: string
  Cluster for which a service summary is requested

{
    "type":"object",
    "required":[
        "cluster"
    ],
    "properties":{
        "cluster":{
            "type":"string",
            "description":"Cluster for which a service summary is requested"
        }
    }
}

Security

• Authorization: apiKey
  Type: apiKey

  Description: Authorization Header value format: 'Bearer [authId]'

Response

Supported Media Types

• application/json

202 Response

Task Created

Body ()

Root Schema : TaskResponse

Type: object

Show Source

• callbackUrl: string
  Callback URL to poll for task status
• taskID: string
  Unique task ID
• timestamp: string
  Task creation timestamp

{
    "type":"object",
    "properties":{
        "taskID":{
            "type":"string",
            "description":"Unique task ID"
        },
        "callbackUrl":{
            "type":"string",
            "description":"Callback URL to poll for task status"
        },
        "timestamp":{
            "type":"string",
            "description":"Task creation timestamp"
        }
    }
}

400 Response

Bad Request

403 Response

Forbidden

500 Response

Internal Server error