SoftLayer Dns Domain ResourceRecord CnameType
From SoftLayer Development Network Wiki
Contents |
Overview
SoftLayer_Dns_Domain_ResourceRecord_CnameType is a SoftLayer_Dns_Domain_ResourceRecord object whose type property is set to "cname" and defines a DNS CNAME record on a SoftLayer hosted domain. A CNAME record directs a host name to another host. For instance, if the CNAME record for "alias.example.org" points to the host "host.example.org" then the host property equals "alias" and the data property equals "host.example.org.".
DNS entries defined by CNAME should not be used as the data field for an MX record.
User Access
Users wishing to access the SoftLayer_Dns_Domain_ResourceRecord_CnameType 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
The string "cname" which defines a resource record as an CNAME 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
