Billing Usage Summary.

POST

/api/data/namespaces/system/billing/usage_summary

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/system/billing/usage_summary \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "end_time": "example", "start_time": "example" }'

• F5 Distributed Cloud Console

GET the aggregated billing usage data for each feature/SKU over the specified duration.

Examples of this operation.

Authorizations

• ApiToken

Request Body^required

Media typeapplication/json

Billing Usage Summary Request

Time interval to GET the billing usage summary.

object

end_time

end_time

Fetch alerts whose timestamp <= end_time format: unix_timestamp|RFC 3339

Optional: If not specified, then the end_time will be evaluated to start_time + 6 hours If start_time is not specified, then the end_time will be evaluated to

string

<= 1024 characters

start_time

start_time

Fetch billing usage summary for timestamp >= start_time format: unix_timestamp|RFC 3339

Optional: If not specified, then the start_time will be evaluated to end_time - 6 hours If end_time is not specified, then the start_time will be evaluated to - 6 hours.

string

<= 1024 characters

Example^generated

{
  "end_time": "example",
  "start_time": "example"
}

Responses

200

A successful response.

Media typeapplication/json

Billing Usage Summary Response

Contains list of usage summary items.

object

usage_summary_items

Configuration parameter for usage summary items

Array<object>

Usage Summary Item

Usage Summary Item represents the usage details for a usage type like Public Load Balancers, for a given service like App Stack.

object

billing_metric_data

object

unit

Unit

Configuration parameter for unit

string

<= 1024 characters

value

Value

Value is derived using division_factor. For eg. If the metric usage is 20 hours over a time duration of 1 day/24h, then division_factor will be 24 hrs, so the billing metric value can be calculated it by dividing the usage value by this factor: 20/24 = 0.83 or if the division_factor is static like 1e12 like in case of bytes, then billing metric value is 100/1e12 (assuming that raw usage is 100 bytes and billing unit is in TB)

string

>= 3 characters <= 1024 characters

name

Name

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

service

Service

Service to which the usage summary item is associated.

string

<= 1024 characters

usage_metric_data

object

metric_value

object

timestamp

Timestamp

Timestamp

number format: double

value

Value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

unit

Unit

Configuration parameter for unit

string

<= 1024 characters

Example^generated

{
  "usage_summary_items": [
    {
      "billing_metric_data": {
        "unit": "example",
        "value": "example"
      },
      "name": "example",
      "service": "example",
      "usage_metric_data": {
        "metric_value": {
          "timestamp": 1,
          "value": "example"
        },
        "unit": "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