GET /dynamicdnsrecord/{uuid}

GET /dynamicdnsrecord/{uuid}

/dynamicdnsrecord/{uuid}

Request
URI
GET
https://{api_host}/api/dynamicdnsrecord/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

string
fields
Optional

List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

boolean
include_name
Optional

All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

boolean
skip_default
Optional

Default values are not set.

string
join_subresources
Optional

It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.


Responses
200

OK

Returns DynamicDnsRecord of type(s) application/json
{
    "_last_modified": "string",
    "algorithm": "string",
    "cname": {
        "cname": "string"
    },
    "delegated": false,
    "description": "string",
    "dns_vs_uuid": "string",
    "fqdn": "string",
    "ip6_address": [
        {
            "ip6_address": {
                "addr": "string",
                "type": "string"
            }
        }
    ],
    "ip_address": [
        {
            "ip_address": {
                "addr": "string",
                "type": "string"
            }
        }
    ],
    "metadata": "string",
    "mx_records": [
        {
            "host": "string",
            "priority": 0
        }
    ],
    "name": "string",
    "ns": [
        {
            "ip6_address": {
                "addr": "string",
                "type": "string"
            },
            "ip_address": {
                "addr": "string",
                "type": "string"
            },
            "nsname": "string"
        }
    ],
    "num_records_in_response": 0,
    "service_locators": [
        {
            "port": 0,
            "priority": 0,
            "target": "string",
            "weight": 0
        }
    ],
    "tenant_ref": "string",
    "ttl": 0,
    "txt_records": [
        {
            "text_str": "string"
        }
    ],
    "type": "string",
    "url": "string",
    "uuid": "string",
    "wildcard_match": false
}
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string
algorithm
Optional
Constraints: default: DNS_RECORD_RESPONSE_ROUND_ROBIN

Specifies the algorithm to pick the IP address(es) to be returned,when multiple entries are configured. This does not apply if num_records_in_response is 0. Default is round-robin. Enum options - DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

object
cname
Optional

cname

boolean
delegated
Optional

Configured FQDNs are delegated domains (i.e. they represent a zone cut). Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
description
Optional

Details of DNS record. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
dns_vs_uuid
Optional

UUID of the DNS VS. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
fqdn
Optional

Fully Qualified Domain Name. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of object
ip6_address
Optional

IPv6 address in AAAA record. Field introduced in 20.1.3. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of object
ip_address
Optional

IP address in A record. Field introduced in 20.1.3. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
metadata
Optional

Internal metadata for the DNS record. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of object
mx_records
Optional

MX record. Field introduced in 20.1.3. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
name
Optional

DynamicDnsRecord name, needed for a top level uuid protobuf, for display in shell. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of object
ns
Optional

Name Server information in NS record. Field introduced in 20.1.3. Maximum of 13 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
num_records_in_response
Optional

Specifies the number of records returned by the DNS service.Enter 0 to return all records. Default is 0. Allowed values are 0-20. Special values are 0- Return all records. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of object
service_locators
Optional

Service locator info in SRV record. Field introduced in 20.1.3. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

tenant_uuid from Dns VS's tenant_uuid. It is a reference to an object of type Tenant. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
ttl
Optional

Time To Live for this DNS record. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of object
txt_records
Optional

Text record. Field introduced in 20.1.3. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
type
Optional

DNS record type. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID of the dns record. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
wildcard_match
Optional

Enable wild-card match of fqdn if an exact match is not found in the DNS table, the longest match is chosen by wild-carding the fqdn in the DNS request. Default is false. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/dynamicdnsrecord/{uuid}