SoftLayer Dns Domain ResourceRecord (type)
From SoftLayer Development Network Wiki
This page refers to the SoftLayer_Dns_Domain_ResourceRecord data type. For information on the SoftLayer_Dns_Domain_ResourceRecord service please see SoftLayer_Dns_Domain_ResourceRecord.
Contents |
Overview
The SoftLayer_Dns_Domain_ResourceRecord data type represents a single resource record entry in a SoftLayer hosted domain. Each resource record contains a host and data property, defining a resource's name and it's target data. Domains contain multiple types of resource records. The type property separates out resource records by type. Type can take one of the following values:
- "a" for address records
- "cname" for canonical name records
- "mx" for mail exchanger records
- "ns" for name server records
- "ptr" for pointer records in reverse domains
- "soa" for a domain's start of authority record
- "txt" for text records
As SoftLayer_Dns_Domain_ResourceRecord objects are created and loaded, the API verifies the type property and casts the object as the appropriate type.
User Access
Users wishing to access the SoftLayer_Dns_Domain_ResourceRecord 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
data
The value of a domain's resource record. This can be an IP address or a hostname. Fully qualified host and domain name data must end with the "." character.
data is required for object creation.
- Type: string
- Length: 255 characters
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
host
The host defined by a resource record. A value of "@" denotes a wildcard.
host is required for object creation.
- Type: string
- Length: 50 characters
- Default Value: @
id
A domain resource record's internal identifier.
- Type: integer
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
A domain resource record's type. A value of "a" denotes an A (address) record, "cname" denotes a CNAME (canonical name) record, "mx" denotes an MX (mail exchanger) record, "ns" denotes an NS (nameserver) record, "ptr" denotes a PTR (pointer/reverse) record, "soa" denotes the SOA (start of authority) record, and "txt" denotes a TXT (text) record. A domain record's type also denotes which class in the SoftLayer API is a best match for extending a resource 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
Associated Methods
- SoftLayer_Dns_Domain::getResourceRecords
- SoftLayer_Dns_Domain::createARecord
- SoftLayer_Dns_Domain::createCnameRecord
- SoftLayer_Dns_Domain::createMxRecord
- SoftLayer_Dns_Domain::createNsRecord
- SoftLayer_Dns_Domain::createTxtRecord
- SoftLayer_Dns_Domain_ResourceRecord::getObject
See Also
- SoftLayer_Dns_Domain
- SoftLayer_Dns_Domain_Reverse
- SoftLayer_Dns_Domain_ResourceRecord_AType
- SoftLayer_Dns_Domain_ResourceRecord_CnameType
- SoftLayer_Dns_Domain_ResourceRecord_MxType
- SoftLayer_Dns_Domain_ResourceRecord_NsType
- SoftLayer_Dns_Domain_ResourceRecord_PtrType
- SoftLayer_Dns_Domain_ResourceRecord_SoaType
- SoftLayer_Dns_Domain_ResourceRecord_TxtType
