Cloud DNS API, REST: DnsZone.ListRecordSets

Field

Description

dnsZoneId

string

Required field. ID of the DNS zone to list record sets in.
To get a DNS zone ID, make a DnsZoneService.List request.

The maximum string length in characters is 255.

Field

Description

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than page_size, the service returns a ListDnsZoneRecordSetsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

The maximum value is 1000.

pageToken

string

Page token. To get the next page of results, set page_token to the
ListDnsZoneRecordSetsResponse.nextPageToken returned by a previous list request.

The maximum string length in characters is 1000.

filter

string

A filter expression that filters record sets listed in the response. The expression consists of one or more conditions united by AND operator: <condition1> [AND <condition2> [<...> AND <conditionN>]].
Each condition has the form <field> <operator> <value>, where:

1. <field> is the field name. Currently you can use filtering only on the RecordSet.name and RecordSet.type fields.
2. <operator> is a logical operator, one of =, !=, IN, NOT IN.
3. <value> represents a value.
   3.1. In case of single value condition (= or !=), the value is a string in double (") or single (') quotes. C-style escape sequences are supported (\" turns to ", \' to ', \\ to backslash).
   3.2. In case of a list of values condition (IN or NOT IN), the value is (<string1>, <string2>, .., <stringN>), where <string> is a string in double (") or single (') quotes.
   Examples of a filter: name="my-record-set", type IN ("MX","A") AND name="works.on.my.machine.".

The maximum string length in characters is 1000.

Field

Description

recordSets[]

RecordSet

List of record sets in the specified DNS zone.

nextPageToken

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListDnsZoneRecordSetsRequest.pageSize, use next_page_token as the value
for the ListDnsZoneRecordSetsRequest.pageToken parameter in the next list request.
Each subsequent page will have its own next_page_token to continue paging through the results.

Field

Description

name

string

Domain name.

The string length in characters must be 1-254.

type

string

Record type.

The string length in characters must be 1-20.

ttl

string (int64)

Time to live in seconds.

Acceptable values are 0 to 2147483647, inclusive.

data[]

string

Data of the record set.

The string length in characters for each value must be 1-1024. The number of elements must be in the range 1-100.

description

string

Description of the record set.