Home

Search endpoints

/search/cb/appt?from={date}&to={date}

Gets chargeback reports per app type and the number of apps in all queues for all users across all clusters.

Request
GET http://unravel-host:3000/api/v1/search/cb/appt?from={date}&to={date}
Path parameters

None.

Query parameters

Required parameters are highlighted.

Name

Type

Description

from

string

Start date. Format: YYYY-MM-DD or Unix epoch value.

to

string

End date. Format: YYYY-MM-DD or Unix epoch value.

Response body

The response body contains one chargeback report per app type. Each report contains the fields shown in the table below.

Name

Type

Description

ms

integer

Memory usage in seconds.

count

integer

App count.

v1

string

App type (mr or spark).

vs

integer

Vcore usage in seconds.

Examples

Request:

curl -X GET "http://myserver.com:3000/api/v1/search/cb/appt?from=1536670860&to=1536757260" -H  "accept: application/json" -H  "Authorization: JWT token"

Response body:

{
  "cb": [
    {
      "ms": 2324825154,
      "count": 4332,
      "v1": "mr",
      "vs": 1512734
    },
    {
      "ms": 298989641,
      "count": 75,
      "v1": "spark",
      "vs": 120404
    }
  ]
}
/search/cb/appt/queue

Gets chargeback reports per queue.

Request
GET http://unravel-host:3000/api/v1/search/cb/appt/queue?from={date}&to={date}
Path parameters

None.

Query parameters

Required parameters are highlighted.

Name

Type

Description

from

string

Start date. Format: YYYY-MM-DD or Unix epoch value.

to

string

End date. Format: YYYY-MM-DD or Unix epoch value.

Response body

The response body contains one chargeback report per queue. Each report contains the fields shown in the table below.

Name

Type

Description

count

string

App count.

v1

string

App type (mr or spark).

cb

array

Chargeback report.

ms

integer

Memory usage in seconds.

count

integer

App count.

v2

string

App type (mr or spark).

vs

integer

Vcore usage in seconds.

Examples

Request:

curl -X GET "http://myserver.com:3000/api/v1/search/cb/appt/queue?from=1536676860&to=1536763260" -H  "accept: application/json" -H  "Authorization: JWT token"

Response:

{
  "cb": [
    {
      "count": 27,
      "v1": "mr",
      "cb": [
        {
          "ms": 1974235,
          "count": 27,
          "v2": "root.users.root",
          "vs": 798
        }
      ]
    }
  ]
}
/search/cb/appt/user?from={date}&to={date}

Gets chargeback reports by application type for a specific queue.

Request
GET http://unravel-host:3000/api/v1/search/cb/appt/user?from={date}&to={date}
Path parameters

None.

Query parameters

Required parameters are highlighted.

Name

Type

Description

from

string

Start date. Format: YYYY-MM-DD or Unix epoch value.

to

string

End date. Format: YYYY-MM-DD or Unix epoch value.

Response body

The response body contains one chargeback report per queue. Each report contains the fields shown in the table below.

Name

Type

Description

count

string

App count.

v1

string

App type (mr or spark).

cb

array

Chargeback report.

ms

integer

Memory usage in seconds.

count

integer

App count.

v2

string

App type (mr or spark).

vs

integer

Vcore usage in seconds.

Examples

Request:

curl -X GET "http://myserver.com:3000/api/v1/search/cb/appt/user?from=1536676860&to=1536763260" -H  "accept: application/json" -H  "Authorization: JWT token"

Response:

{
  "cb": [
    {
      "count": 27,
      "v1": "mr",
      "cb": [
        {
          "ms": 1974235,
          "count": 27,
          "v2": "root.users.root",
          "vs": 798
        }
      ]
    }
  ]
}