SoftLayer Dns Domain (type)
From SoftLayer Development Network Wiki
This page refers to the SoftLayer_Dns_Domain data type. For information on the SoftLayer_Dns_Domain service please see SoftLayer_Dns_Domain.
Contents |
Overview
The SoftLayer_Dns_Domain data type represents a single DNS domain record hosted on the SoftLayer nameservers. Domains contain general information about the domain name such as name and serial. Individual records such as A, AAAA, CTYPE, and MX records are stored in the domain's associated SoftLayer_Dns_Domain_ResourceRecord records.
User Access
Users wishing to access the SoftLayer_Dns_Domain 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
id
A domain record's internal identifier.
- Type: integer
name
A domain's name including top-level domain, for example "example.com".
name must be a unique value.
name is required for object creation.
- Type: string
- Length: 150 characters
serial
A unique number denoting the latest revision of a domain. Whenever a domain is changed its corresponding serial number is also changed. Serial numbers typically follow the format yyyymmdd## where yyyy is the current year, mm is the current month, dd is the current day of the month, and ## is the number of the revision for that day. A domain's serial number is automatically updated when edited via the API.
serial is required for object creation.
- Type: integer
- Length: 20 digits
Relational Properties
account
The SoftLayer customer account that owns a domain.
account can be queried by object mask.
account must be a unique value.
- Type: SoftLayer_Account
resourceRecords
The individual records contained within a domain record. These include but are not limited to A, AAAA, MX, CTYPE, and TXT records.
resourceRecords can be queried by object mask.
secondary
The secondary DNS record that defines this domain as being managed through zone transfers.
secondary can be queried by object mask.
secondary must be a unique value.
- Type: SoftLayer_Dns_Secondary
Count Properties
resourceRecordCount
A count of the individual records contained within a domain record. These include but are not limited to A, AAAA, MX, CTYPE, and TXT records.
resourceRecordCount must be a unique value.
- Type: unsigned long
Associated Methods
- SoftLayer_Account::getDomains
- SoftLayer_Dns_Domain::getObject
- SoftLayer_Dns_Domain_ResourceRecord::getDomain
