SoftLayer Dns Domain ResourceRecord SoaType
From SoftLayer Development Network Wiki
Contents |
Overview
SoftLayer_Dns_Domain_ResourceRecord_SoaType defines a domains' Start of Authority (or SOA) resource record. A domain's SOA record contains a domain's general and propagation information. Every domain must have one SOA record, and it is not possible to remove a domain's SOA record.
SOA records typically contain a domain's serial number, but the SoftLayer API associates a domain's serial number directly with it's SoftLayer_Dns_Domain record.
User Access
Users wishing to access the SoftLayer_Dns_Domain_ResourceRecord_SoaType type must have the Manage DNS permission assigned to their account.
| Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties. |
Local Properties
domainId
An identifier belonging to the domain that a resource record is associated with.
domainId is required for object creation.
- Type: integer
- Length: 8 digits
expire
The amount of time in seconds that a secondary name server (or servers) will hold a zone before it is no longer considered authoritative.
- Type: integer
- Length: 8 digits
- Default Value: 604800
id
A domain resource record's internal identifier.
- Type: integer
minimum
The amount of time in seconds that a domain's resource records are valid. This is also known as a minimum TTL, and can be overridden by an individual resource record's TTL.
- Type: integer
- Length: 8 digits
- Default Value: 3600
refresh
The amount of time in seconds that a secondary name server should wait to check for a new copy of a DNS zone from the domain's primary name server. If a zone file has changed then the secondary DNS server will update it's copy of the zone to match the primary DNS server's zone.
- Type: integer
- Length: 8 digits
- Default Value: 3600
responsiblePerson
The email address of the person responsible for a domain, with the "@" replaced with a ".". For instance, if root@example.org is responsible for example.org, then example.org's SOA responsibility is "root.example.org.".
responsiblePerson is required for object creation.
- Type: string
retry
The amount of time in seconds that a domain's primary name server (or servers) should wait if an attempt to refresh by a secondary name server failed before attempting to refresh a domain's zone with that secondary name server again.
- Type: integer
- Length: 8 digits
- Default Value: 300
ttl
The Time To Live value of a resource record, measured in seconds. TTL is used by a name server to determine how long to cache a resource record. An SOA record's TTL value defines the domain's overall TTL.
ttl is required for object creation.
- Type: integer
- Length: 8 digits
- Default Value: 86400
type
The string "soa" which defines a resource record as an SOA record.
type is required for object creation.
- Type: string
- Length: 5 characters
Relational Properties
domain
The domain that a resource record belongs to.
domain can be queried by object mask.
domain must be a unique value.
- Type: SoftLayer_Dns_Domain
