Status

GET

/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/global/{vesnamespace}/status

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/operate/namespaces/example/sites/example/vpm/debug/global/example/status \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

GET Status of F5XC components.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Namespace for which the request is sent (system)

site

required

string

Site Name Name of the site.

vesnamespace

required

string

F5XC Namespace Name of the site’s namespace. Default’s to VES-system.

Query Parameters

cached

boolean format: boolean

Use cached results in Status API.

Responses

200

A successful response.

Media typeapplication/json

Status Response

Status response.

object

status

Status

List of status from site.

Array<object>

>= 17 characters <= 17 characters

Status

Status of the service.

object

message

Message

Human readable reason of the Status.

string

<= 1024 characters

name

Name

Name of the service.

string

>= 6 characters <= 1024 characters

node

Node

Node where service runs.

string

<= 1024 characters

status

Status

Status of the service.

string

>= 17 characters <= 1024 characters

Example^generated

{
  "status": [
    {
      "message": "example",
      "name": "example",
      "node": "example",
      "status": "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