GET DNS Info.

GET

/api/config/namespaces/{namespace}/tcp_loadbalancers/{name}/get-dns-info

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/tcp_loadbalancers/example/get-dns-info \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

GetDnsInfo is an API to GET DNS information for a given TCP load balancer.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Namespace for the TCP load balancer.

name

required

string

Name Name of the TCP load balancer.

Responses

200

A successful response.

Media typeapplication/json

GetDnsInfoResponse

Response for GET-DNS-info API.

object

dns_info

object

dns_info

DNS information

DNS information for this virtual host.

Array<object>

DNS information

A message that contains DNS information for a given IP address.

object

ip_address

IP address

IP address associated with virtual host.

string

<= 1024 characters

host_name

host name

Host name to be used for the virtual host.

string

<= 1024 characters

virtual_host

virtual host

Reference to virtual host object to which this information applies.

Array<object>

ObjectRefType

This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

Example^generated

{
  "dns_info": {
    "dns_info": [
      {
        "ip_address": "example"
      }
    ],
    "host_name": "example",
    "virtual_host": [
      {
        "name": "example",
        "namespace": "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