list-dns-entries¶

Description¶

List all DNS entries for an accountId.

list-dns-entries is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.

Synopsis¶

  list-dns-entries
--environment-crn <value>
[--record-type <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment-crn (string)

The CRN of the environment, for which the DNS entries are being listed.

--record-type (string)

The type of DNS record. A - A record type (IPv4 address). TXT - TXT record type (text record). CNAME - CNAME record type (canonical name).

Possible values:

• A

• TXT

• CNAME

--max-items (integer)

The total number of items to return. If the total number of items available is more than the value specified in max-items then a nextToken will be provided in the output that you can use to resume pagination. This nextToken response element should not be used directly outside of the CDP CLI. This option cannnot be combined with the no-paginate CLI option. If no max-items value is specified, then a default value of 100 is used.

--starting-token (string)

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

--page-size (integer)

The size of each page. Generally this does not need to be set and the default page size used is appropriate.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

dnsEntries -> (array)

List of DNS entries for the specified environment.

item -> (object)

DnsEntryResponse represents a DNS entry with its name, type, target records, and optional TTL.

dnsRecordName -> (string)

The DNS name for this entry, e.g. example.com.

dnsRecordType -> (string)

The type of DNS record. A - A record type (IPv4 address). TXT - TXT record type (text record). CNAME - CNAME record type (canonical name).

dnsTargetRecords -> (object)

DnsTargetRecord represents the target of a DNS entry.

resourceRecords -> (object)

ResourceRecords holds a list of values for DNS resource records, such as IP addresses or CNAMEs.

values -> (array)

Values can be IP addresses or CNAMEs.

item -> (string)

dnsTTL -> (string)

Time to live for the DNS entry, in seconds.

nextPageToken -> (string)

The page token for requesting the next page of results.

Form Factors¶

public