All Products
Search
Document Center

domain Operation

Last Updated: Aug 15, 2019

Setting Smtp Password for Domain

Creating Domain

Get domain configuration

Query the list of domain

Verify domain

Setting Smtp Password for Domain

Description

ModifyPWByDomain API is used for setting Smtp Password for Domain.

Request parameters

Name Type Required? Description
Action String Required API name, a system required parameter. Value: ModifyPWByDomain.
DomainName String Required domain, length 1 to 50, including numbers or capitals or lowercase letters or . or -
Password String Required password

For other request parameters, see Public parameters.

Response parameters

For more information about public response parameters, see Public parameters.

Error codes

Error code Description HTTP status code Meaning
InvalidDomainPassword.Malformed The specified domain password is wrongly formed.
InvalidDomainPassword.equalcurrent The new password cannot be the same as the old one
InvalidDomainName.Malformed The specified domain name is wrongly formed.
InvalidDomain.NotFound The specified domain is not found.
InvalidDomainStatus.Malformed The specified domain status is wrongly formed.
InvalidDomainId.Malformed The specified domain id is wrongly formed.

Creating Domain

Description

CreateDomain API is used for creating Domain.

Request parameters

Name Type Required? Description
Action String Required API name, a system required parameter. Value: CreateDomain.
DomainName String Required Domain, length 1 to 50, including numbers or capitals or lowercase letters or . or -

For other request parameters, see Public parameters.

Response parameters

Name Type Description
domainId int

For more information about public response parameters, see Public parameters.

Error codes

Error code Description HTTP status code Meaning
InvalidDomainName.Duplicate The specified domain has already existed.
InvalidDomainNumber.Malformed The amount of domain exceeds the limit.
InvalidDomainName.Malformed The specified domain name is wrongly formed.
InvalidDomainName.Conflict The specified domain name is already used by another user.
InvalidDomain.NotFound The specified domain is not found.

Get domain configuration

Description

DescDomain API is used for querying domain configuration.

Request parameters

Name Type Required? Description
Action String Required API name, a system required parameter. Value: DescDomain.
DomainId Integer Required Domain id

For other request parameters, see Public parameters.

Response parameters

Name Type Description
data data

data

Name Type Description
domainId int
domainName String domain
domainType String domain type
cnameRecord String cName record
cnameConfirmStatus int cName confirm status,Success:0; fail:1
spfAuthStatus int spf verification flag,Success:0; fail:1
mxAuthStatus int mx verification flag,Success:0; fail:1
createTime Date
utcCreateTime Long
cnameAuthStatus int track verification
icpStatus int The status is construction puts a record of the domain name, not pass:0; Passed:1
DomainStatus int The status of the domain name(0:Available,Passed;1:Unavailable,No passed;2:Available,cname no passed,icp no passed;3:Available, icp no passed;4: Available,cname no passed)

For more information about public response parameters, see Public parameters.

Error codes

Error code Description HTTP status code Meaning
InvalidDomainId.Malformed The specified domainId is not exist.

Query the list of domain

Description

QueryDomainByParam API is used for querying the list of domain.

Request parameters

Name Type Required? Description
Action String Required API name, a system required parameter. Value: QueryDomainByParam.
Keyword String Required domain, length 1 to 50, including numbers or capitals or lowercase letters or . or -
Status String Required 0:Verified; 1:Failed
PageNo String Optional Offset Page No
PageSize String Optional Number of Items each page

For other request parameters, see Public parameters.

Response parameters

Name Type Description
data data

data

Name Type Description
data Array data record

data record

Name Type Description
domainId int
domainName String domain
domainType String domain type
cnameRecord String cName record
cnameConfirmStatus int cName confirm status,Success:0; fail:1
spfAuthStatus int spf verification flag,Success:0; fail:1
mxAuthStatus int mx verification flag,Success:0; fail:1
createTime Date
utcCreateTime Long
cnameAuthStatus int track verification
icpStatus int The status is construction puts a record of the domain name, not pass:0; Passed:1
DomainStatus int The status of the domain name(0:Available,Passed;1:Unavailable,No passed;2:Available,cname no passed,icp no passed;3:Available, icp no passed;4: Available,cname no passed)

For more information about public response parameters, see Public parameters.

Verify domain

Description

CheckDomain API is used for verifying domain.

Request parameters

Name Type Required? Description
Action String Required API name, a system required parameter. Value: CheckDomain.
DomainId Integer Required domain id

For other request parameters, see Public parameters.

Response parameters

Name Type Description
DomainStatus int The status of the domain name(0:Available,Passed;1:Unavailable,No passed;2:Available,cname no passed,icp no passed;3:Available, icp no passed;4: Available,cname no passed)

For more information about public response parameters, see Public parameters.

Error codes

Error code Description HTTP status code Meaning
InvalidDomainId.Malformed The specified domainId is not exist.
CheckDomain.Failed The specified domain was checked failed.
InvalidDomainName.DuplicateTLD The specified domain of top-level domain name already exists.