DNS Load Balancer Health Status List.

GET

/api/data/namespaces/{namespace}/dns_load_balancers/health_status

const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/example/dns_load_balancers/health_status';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

GET Health Status of all DNS Load Balancers in a namespace.

Examples of this operation.

Authorizations

ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Namespace to scope the listing of DNS LB health status.

Responses

200

A successful response.

application/json

DNSLBHealthStatusListResponse

Response for DNS Load Balancer Health Status List Request.

object

dns_lb_pools_status_summary

DNS Load Balancer Pools Status Summary

Summary of DNS Load Balancer Pools by Health Status.

Array<object>

HealthStatusSummary

Health Status Summary.

object

count

Count

Number of objects.

Array<object>

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

status

string

default: HEALTH_STATUS_UNHEALTHY

Allowed values: HEALTH_STATUS_UNHEALTHY HEALTH_STATUS_DEGRADED HEALTH_STATUS_HEALTHY HEALTH_STATUS_DISABLED

dns_load_balancer_status_summary

DNS Load Balancer Status Summary

Summary of DNS Load Balancers by Health Status.

Array<object>

HealthStatusSummary

Health Status Summary.

object

count

Count

Number of objects.

Array<object>

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

status

string

default: HEALTH_STATUS_UNHEALTHY

Allowed values: HEALTH_STATUS_UNHEALTHY HEALTH_STATUS_DEGRADED HEALTH_STATUS_HEALTHY HEALTH_STATUS_DISABLED

items

Items

Collection of DNS Load Balancer Health status.

Array<object>

DNSLBHealthStatusListResponseItem

Individual item in a collection of DNS Load Balancer.

object

dns_lb_pools_status_summary

DNS Load Balancer Pools Status Summary

Summary of DNS Load Balancer Pools by Health Status.

Array<object>

HealthStatusSummary

Health Status Summary.

object

count

Count

Number of objects.

Array<object>

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

status

string

default: HEALTH_STATUS_UNHEALTHY

Allowed values: HEALTH_STATUS_UNHEALTHY HEALTH_STATUS_DEGRADED HEALTH_STATUS_HEALTHY HEALTH_STATUS_DISABLED

name

Name

Name of the DNS Load Balancer.

string

>= 6 characters <= 1024 characters

status

Status

Health Status of DNS Load Balancer.

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

{
  "dns_lb_pools_status_summary": [
    {
      "count": [
        {
          "trend_value": {
            "sentiment": "TREND_SENTIMENT_NONE"
          }
        }
      ],
      "status": "HEALTH_STATUS_UNHEALTHY"
    }
  ],
  "dns_load_balancer_status_summary": [
    {
      "count": [
        {
          "trend_value": {
            "sentiment": "TREND_SENTIMENT_NONE"
          }
        }
      ],
      "status": "HEALTH_STATUS_UNHEALTHY"
    }
  ],
  "items": [
    {
      "dns_lb_pools_status_summary": [
        {
          "count": [
            {
              "trend_value": {
                "sentiment": "TREND_SENTIMENT_NONE"
              }
            }
          ],
          "status": "HEALTH_STATUS_UNHEALTHY"
        }
      ],
      "status": [
        {
          "trend_value": {
            "sentiment": "TREND_SENTIMENT_NONE"
          }
        }
      ]
    }
  ]
}

401

Returned when operation is not authorized.

application/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

application/json

string format: string

Example^generated

example

404

Returned when resource is not found.

application/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

application/json

string format: string

Example^generated

example

429

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

application/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

application/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

application/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

application/json

string format: string

Example^generated

example

DNS Load Balancer Health Status List.

Authorizations

Parameters

Path Parameters

Responses

200

Example

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

429

Examplegenerated

500

Examplegenerated

503

Examplegenerated

504

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated