All Products
Document Center

Add Domain Names

Last Updated: Sep 29, 2017


Adds domain name based on input parameters. To determine the legality of a domain name, please refer to the Domain Name Validity.

Request Parameters

Name Type Required? Description
Action String Yes Operator interface name, required parameter, value:AddDomain
DomainName String Yes Domain name
GroupId String No Domain name group, which is, by default, the GroupId of the “Default Group”

Return Parameters

Public return parameters. For details, see Public Return Parameters.

Name Type Description
RequestId String The unique request identifier
DomainId String Domain name ID
DomainName String Domain name
GroupId String Domain name group ID
GroupName String The name of the domain name group
PunyCode String punycode returned only for a Chinese domain name
DnsServers DnsServerType The DNS list for the domain name under resolution

Error Codes

For errors common to all interfaces, please refer to the Error Code Table.

Error Code Description HTTP Status Code Language
InvalidDomainName.Format The format of domain is error. 400 Domain name format error
InvalidDomainName.Suffix The domain suffix isnot been supported. 400 The domain name suffix is not supported
InvalidDomainName.Unregistered The domain name is not registered. 400 The domain name is not registered
InvalidDomainName.Duplicate The domain name is duplicated in this user’s domain list. 400 The domain name already exists in the user’s domain list
DomainAddedByOthers The domain name has been added by other users. 400 This domain name already exists in the domain list of another user
CHNDomainInfoNotMatch The information of chinese domain does not match with CNNIC. 400 The Chinese domain name does not match the information returned by CNNIC (See Note)
UnabletoGetWoisInfo The domain is unable to get information from whois system. 400 Cannot retrieve Whois information
InvalidDomainGroup.NotExist The domain group name is not exist. 400 The domain name group does not exist


Request Example

  2. &
  3. &GroupId=2223
  4. &<Public Request Parameters>

Return Example

XML Format

  1. <AddDomainResponse>
  2. <RequestId>536E9CAD-DB30-4647-AC87-AA5CC38C5382</RequestId>
  3. <DomainId>00efd71a-770e-4255-b54e-6fe5659baffe</DomainId>
  4. <DomainName></DomainName>
  5. <GroupId>2223</GroupId>
  6. <GroupName>MyGroup</GroupName>
  7. <PunyCode></PunyCode>
  8. <DnsServers>
  9. <DnsServer></DnsServer>
  10. <DnsServer></DnsServer>
  11. </DnsServers>
  12. </AddDomainResponse>

JSON Example

  1. {
  2. "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  3. "DomainId": "00efd71a-770e-4255-b54e-6fe5659baffe",
  4. "DomainName": "",
  5. "GroupId": "2223",
  6. "GroupName": "MyGroup",
  7. "PunyCode": "",
  8. "DnsServers": {
  9. "DnsServer": [
  10. "",
  11. ""
  12. ]
  13. }
  14. }