Skip to content
API Enriched

Discovered Service Health Status.

GET
/api/data/namespaces/{namespace}/discovered_services/{name}/health_status
curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/example/discovered_services/example/health_status \
  --header 'Authorization: <Authorization>'

GET Discovered Service Health status.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace

x-required Namespace in which the Discovered Service is present.

name
required
string

Name

x-required Name of the Discovered Service.

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
DiscoveredServiceHealthStatusResponse

Response for Discovered Service Health Status Request.

object
status
Status

Health Status of Discovered Service.

Array<object>
>= 17 characters <= 17 characters
Metric Value

Metric data contains timestamp and the value.

object
timestamp
Timestamp

Timestamp

number format: double
trend_value
object
description
Description

Description of the method used to calculate trend.

string
>= 21 characters <= 1024 characters
previous_value
Previous Value

Configuration parameter for previous value

string
<= 1024 characters
sentiment
string
default: TREND_SENTIMENT_NONE
Allowed values: TREND_SENTIMENT_NONE TREND_SENTIMENT_POSITIVE TREND_SENTIMENT_NEGATIVE
value
Value

Configuration parameter for value

string
>= 3 characters <= 1024 characters
value
Value

Configuration parameter for value

string
>= 3 characters <= 1024 characters
virtual_server_pool_members_health
object
virtual_server_pool_members
BIG-IP Virtual Server's Pool Member Health

Collection of Pool member health status.

Array<object>
VirtualServerPoolHealthStatusListResponseItem

Pool member health.

object
name
Name

Name of the Virtual Server’s Pool Member.

string
>= 6 characters <= 1024 characters
status
Status

Health Status of Pool Member.

Array<object>
>= 17 characters <= 17 characters
Metric Value

Metric data contains timestamp and the value.

object
timestamp
Timestamp

Timestamp

number format: double
trend_value
object
description
Description

Description of the method used to calculate trend.

string
>= 21 characters <= 1024 characters
previous_value
Previous Value

Configuration parameter for previous value

string
<= 1024 characters
sentiment
string
default: TREND_SENTIMENT_NONE
Allowed values: TREND_SENTIMENT_NONE TREND_SENTIMENT_POSITIVE TREND_SENTIMENT_NEGATIVE
value
Value

Configuration parameter for value

string
>= 3 characters <= 1024 characters
value
Value

Configuration parameter for value

string
>= 3 characters <= 1024 characters
Example
{
  "status": [
    {
      "trend_value": {
        "sentiment": "TREND_SENTIMENT_NONE"
      }
    }
  ],
  "virtual_server_pool_members_health": {
    "virtual_server_pool_members": [
      {
        "status": [
          {
            "trend_value": {
              "sentiment": "TREND_SENTIMENT_NONE"
            }
          }
        ]
      }
    ]
  }
}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

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

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example