A DNS NAPTR object represents a Naming Authority Pointer (NAPTR) resource record. This resource record specifies a regular expression-based rewrite rule that, when applied to an existing string, produces a new domain name or URI.
References to record:naptr are object references. The name part of a NAPTR record object reference has the following components:
- Name of the record
- Name of the view
Example: record:naptr/ZG5zLmhvc3RjkuMC4xLg:9.9.0.1/some.name.com/default
The object does not support the following operations when managed on Cloud Platform members:
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): name, order, preference, regexp, replacement, services, view.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| name | |
| order | |
| preference | |
| replacement |
Structure containing all cloud API related information for this object.
Type
A/An Cloud Information struct.
Search
The field is not available for search.
Notes
The cloud_info cannot be updated.
cloud_info cannot be written.
Comment for the record; maximum 256 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is available for search via
The time of the record creation in Epoch seconds format.
Type
Timestamp.
Search
The field is not available for search.
Notes
The creation_time cannot be updated.
creation_time cannot be written.
The record creator.
Note that changing creator from or to ‘SYSTEM’ value is not allowed.
Type
String.
Create
The default value is STATIC.
Search
The field is available for search via
The GSS-TSIG principal that owns this record.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
Determines if the DDNS updates for this record are allowed or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if the record is disabled or not. False means that the record is enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The name of the NAPTR record in punycode format.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is not available for search.
Notes
The dns_name cannot be updated.
dns_name cannot be written.
The replacement field of the NAPTR record in punycode format.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is not available for search.
Notes
The dns_replacement cannot be updated.
dns_replacement cannot be written.
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
The flags used to control the interpretation of the fields for an NAPTR record object. Supported values for the flags field are “U”, “S”, “P” and “A”.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is An empty string.
Search
The field is available for search via
Determines if the reclamation is allowed for the record or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The time of the last DNS query in Epoch seconds format.
Type
Timestamp.
Search
The field is not available for search.
Notes
The last_queried cannot be updated.
last_queried cannot be written.
The name of the NAPTR record in FQDN format. This value can be in unicode format.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The name is part of the base object.
The order parameter of the NAPTR records. This parameter specifies the order in which the NAPTR rules are applied when multiple rules are present. Valid values are from 0 to 65535 (inclusive), in 32-bit unsigned integer format.
Type
Unsigned integer.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The order is part of the base object.
The preference of the NAPTR record. The preference field determines the order NAPTR records are processed when multiple records with the same order parameter are present. Valid values are from 0 to 65535 (inclusive), in 32-bit unsigned integer format.
Type
Unsigned integer.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The preference is part of the base object.
Determines if the record is reclaimable or not.
Type
Bool.
Search
The field is available for search via
Notes
The reclaimable cannot be updated.
reclaimable cannot be written.
The regular expression-based rewriting rule of the NAPTR record. This should be a POSIX compliant regular expression, including the substitution rule and flags. Refer to RFC 2915 for the field syntax details.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is An empty string.
Search
The field is not available for search.
Notes
The regexp is part of the base object.
The replacement field of the NAPTR record object. For nonterminal NAPTR records, this field specifies the next domain name to look up. This value can be in unicode format.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The replacement is part of the base object.
The services field of the NAPTR record object; maximum 128 characters. The services field contains protocol and service identifiers, such as “http+E2U” or “SIPS+D2T”.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is An empty string.
Search
The field is available for search via
Notes
The services is part of the base object.
The Time to Live (TTL) value for the NAPTR record. A 32-bit unsigned integer that represents the duration, in seconds, for which the record is valid (cached). Zero indicates that the record should not be cached.
Type
Unsigned integer.
Create
The default value is empty.
Search
The field is not available for search.
Notes
Use flag for: ttl
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The name of the DNS view in which the record resides. Example: “external”.
Type
String.
Create
The default value is The default DNS view.
Search
The field is available for search via
Notes
The view is part of the base object.
The view cannot be updated.
The name of the zone in which the record resides. Example: “zone.com”. If a view is not specified when searching by zone, the default view is used.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
Notes
The zone cannot be updated.
zone cannot be written.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| cloud_info | struct | N | Y | N | N/A |
| comment | String | N | N | N | : = ~ |
| creation_time | Timestamp | N | Y | N | N/A |
| creator | String | N | N | N | = |
| ddns_principal | String | N | N | N | : = ~ |
| ddns_protected | Bool | N | N | N | N/A |
| disable | Bool | N | N | N | N/A |
| dns_name | String | N | Y | N | N/A |
| dns_replacement | String | N | Y | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| flags | String | N | N | N | : = ~ |
| forbid_reclamation | Bool | N | N | N | N/A |
| last_queried | Timestamp | N | Y | N | N/A |
| name | String | Y | N | Y | : = ~ |
| order | Unsigned int | Y | N | Y | < = > |
| preference | Unsigned int | Y | N | Y | < = > |
| reclaimable | Bool | N | Y | N | = |
| regexp | String | N | N | Y | N/A |
| replacement | String | Y | N | Y | = ~ |
| services | String | N | N | Y | : = ~ |
| ttl | Unsigned int | N | N | N | N/A |
| use_ttl | Bool | N | N | N | N/A |
| view | String | N | N | Y | = |
| zone | String | N | Y | N | = |
record:mx : DNS MX record object.
