Skip to content

State

GET
/api/shape/recognize/namespaces/system/recognize/addon/state
curl --request GET \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/recognize/namespaces/system/recognize/addon/state \
--header 'Authorization: <Authorization>'

GET customer State if after or before.

Examples of this operation.

A successful response.

Media typeapplication/json
StateResponse

The data of State Response.

object
apiVersion
apiVersion

The actual version of the shape recognize API.

string
<= 1024 characters
data
object
OBSOLETE2_jsDetectedTime
OBSOLETE2_jsDetectedTime

The detected time.

string format: int64
<= 1024 characters
OBSOLETE2_recommendationConsumptionTime
OBSOLETE2_recommendationConsumptionTime

The recommendation consumption time.

string format: int64
<= 1024 characters
OBSOLETE_jsDetectedTime
OBSOLETE_jsDetectedTime

The detected time.

string
<= 1024 characters
OBSOLETE_recommendationConsumptionTime
OBSOLETE_recommendationConsumptionTime

The recommendation consumption time.

string
<= 1024 characters
code
code

The code response.

integer format: int32
dashboardState
dashboardState

The conversion data to fill the chart.

string
<= 1024 characters
jsDetectedTime
jsDetectedTime

The detected time.

number format: double
recommendationConsumptionTime
recommendationConsumptionTime

The recommendation consumption time.

number format: double
id
id

The ID from the State Response.

string
>= 1 <= 4094 <= 1024 characters
Examplegenerated
{
"apiVersion": "example",
"data": {
"OBSOLETE2_jsDetectedTime": "example",
"OBSOLETE2_recommendationConsumptionTime": "example",
"OBSOLETE_jsDetectedTime": "example",
"OBSOLETE_recommendationConsumptionTime": "example",
"code": 1,
"dashboardState": "example",
"jsDetectedTime": 1,
"recommendationConsumptionTime": 1
},
"id": "example"
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

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

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example