Consumption Summary.

GET

/api/shape/bot/namespaces/{namespace}/reporting/consumption/summary

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/bot/namespaces/example/reporting/consumption/summary \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

GET Consumption summary.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace

x-required namespace is used to scope traffic usage query. Only virtual_host in given namespace will be considered.

Query Parameters

start

string

Or “2022-08-01” The start date of the query period. Format: YYYY-MM or YYYY-MM-DD.

end

string

Or “2022-09-30” The end date of the query period. Format: YYYY-MM or YYYY-MM-DD.

Responses

200

A successful response.

Media typeapplication/json

Consumption Summary Response

Response for Consumption Summary.

object

sums

Consumption Summary

Consumption summary data.

Array<object>

Consumption Summary Data

object

all

All Traffic

All traffic count.

string format: uint64

<= 1024 characters

day

Day of the traffic Consumption Summary

Exclusive with [month] Day Identifier, format: YYYYMMDD.

string

<= 1024 characters

month

Month of the traffic Consumption Summary

Exclusive with [day] Month Identifier, format: YYYYMM.

string

<= 1024 characters

telemetry_client

Telemetry Client Count

Counts of telemetry client.

string format: uint64

<= 1024 characters

Example^generated

{
  "sums": [
    {
      "all": "example",
      "day": "example",
      "month": "example",
      "telemetry_client": "example"
    }
  ]
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example