Rescue Dashboard.

POST

/api/shape/recognize/namespaces/system/recognize/addon/dashboard/rescue

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/recognize/namespaces/system/recognize/addon/dashboard/rescue \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "endTime": "example", "itemUnit": "example", "startTime": "example" }'

• F5 Distributed Cloud Console

GET rescue chart data from shape recognize API.

Examples of this operation.

Authorizations

• ApiToken

Request Body^required

Media typeapplication/json

Rescue Request

Since and to times to generate the Rescue Request.

object

endTime

endTime

The time to we want the rescue data Required: YES.

string format: int64

<= 1024 characters

itemUnit

itemUnit

The unit where the data is represented.

string

<= 1024 characters

startTime

startTime

The time since we want the rescue data Required: YES.

string format: int64

<= 1024 characters

Example^generated

{
  "endTime": "example",
  "itemUnit": "example",
  "startTime": "example"
}

Responses

200

A successful response.

Media typeapplication/json

RescueResponse

The data of Rescue Response Chart.

object

apiVersion

ApiVersion

The actual version of the shape recognize API.

string

<= 1024 characters

data

object

OBSOLETE2_endTime

endTime

End Time

integer format: int32

OBSOLETE2_startTime

OBSOLETE2_startTime

Start Time.

integer format: int32

OBSOLETE_endTime

OBSOLETE_endTime

End Time

string format: int64

<= 1024 characters

OBSOLETE_startTime

OBSOLETE_startTime

Start Time.

string format: int64

<= 1024 characters

abandonLoginCount

abandonLoginCount

Abandon Login Count.

number format: double

endTime

endTime

End Time

number format: double

itemUnit

itemUnit

The system unit to represent the data.

string

<= 1024 characters

items

items

The collection of data to be filled into the chart.

Array<object>

Rescue Item

Conversion Item that represent the data to chart.

object

OBSOLETE2_upperBound

OBSOLETE2_upperBound

The upperBound data.

integer format: int32

OBSOLOTE_upperBound

OBSOLOTE_upperBound

The upperBound data.

string format: int64

<= 1024 characters

upperBound

upperBound

The upperBound data.

number format: double

value

value

The value of the data to display in chart.

number format: double

>= 3 characters <= 15 characters

kind

kind

See if the chart is after or before extension.

string

>= 12 characters <= 1024 characters

noBenefit

noBenefit

No Benefit.

number format: double

startTime

startTime

Start Time.

number format: double

totalItems

totalItems

Total items to be filled into the chart.

integer format: int32

id

Id

The ID from the Rescue Response.

string

>= 1 <= 4094 <= 1024 characters

Example^generated

{
  "apiVersion": "example",
  "data": {
    "OBSOLETE2_endTime": 1,
    "OBSOLETE2_startTime": 1,
    "OBSOLETE_endTime": "example",
    "OBSOLETE_startTime": "example",
    "abandonLoginCount": 1,
    "endTime": 1,
    "itemUnit": "example",
    "items": [
      {
        "OBSOLETE2_upperBound": 1,
        "OBSOLOTE_upperBound": "example",
        "upperBound": 1,
        "value": 1
      }
    ],
    "kind": "example",
    "noBenefit": 1,
    "startTime": 1,
    "totalItems": 1
  },
  "id": "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