Skip to content
API Enriched

DNS Load Balancer Health Status.

GET
/api/data/namespaces/{namespace}/dns_load_balancers/{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/dns_load_balancers/example/health_status \
  --header 'Authorization: <Authorization>'

GET DNS Load Balancer Health status.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace Namespace in which the DNS Load Balancer is present.

name
required
string

Name Name of the DNS Load Balancer.

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
DNSLBHealthStatusResponse

Response for DNS Load Balancer Health Status Request.

object
dns_lb_pool_items
DNS Load Balancer Pool Items

Collection of DNS Load Balancer Pools.

Array<object>
DNSLBPoolHealthStatusListResponseItem

Individual item in a collection of DNS Load Balancer Pool.

object
dns_lb_pool_members_status_summary
DNS Load Balancer Pool Members Status Summary

Summary of DNS Load Balancer Pool Members 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
health_check_type
Health Check Type

Health Check Type associated with the DNS Load Balancer Pool.

string
<= 1024 characters
name
Name

Name of the DNS Load Balancer Pool.

string
>= 6 characters <= 1024 characters
status
Status

Health Status of DNS Load Balancer Pool.

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
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_pool_items": [
    {
      "dns_lb_pool_members_status_summary": [
        {
          "count": [
            {
              "trend_value": {
                "sentiment": "TREND_SENTIMENT_NONE"
              }
            }
          ],
          "status": "HEALTH_STATUS_UNHEALTHY"
        }
      ],
      "status": [
        {
          "trend_value": {
            "sentiment": "TREND_SENTIMENT_NONE"
          }
        }
      ]
    }
  ],
  "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