API Description

<p><strong>1. AddDomain</strong></p> <p><strong>Interface Description</strong></p> <p>Add Domain</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Name</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Domain Name</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>2. AddDomainResolve</strong></p> <p><strong>Interface Description</strong></p> <p>Add Domain Resolution Record</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>DomainId</p> </td> <td> <p>Long</p> </td> <td> <p>yes</p> </td> <td> <p>Add domain id of the Resolution record</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DomainName</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Add domain name of the Resolution record</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SubDomain</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Add instance record of the Resolution record</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DomainType</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Add record type of the Resolution record</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>LineType</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Add line type of the Resolution record</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RecordValue</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Add record value of the Resolution record, (when domainType is A,the record value is IP value; when domainType&nbsp; is CNAME,the record value is domain)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Weights</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>Weight</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>MxPriority</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>MX Priority</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Priority</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Priority</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Ttl</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>Response Time</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>3. CountDomain</strong></p> <p><strong>Interface Description</strong></p> <p>Domain Count</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>TenantId</p> </td> <td> <p>Long</p> </td> <td> <p>no</p> </td> <td> <p>Tenant id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Count</p> </td> <td> <p>Integer</p> </td> <td> <p>Tenant Domain Count</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>4. DeleteDomainResolve</strong></p> <p><strong>Interface Description</strong></p> <p>Delete Domain Resolution Record</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>RecordIDs</p> </td> <td> <p>String[]</p> </td> <td> <p>yes</p> </td> <td> <p>Select the resolution record ids to delete</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DomainName</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Delete domain name of the resolution record</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>5. DeleteDomains</strong></p> <p><strong>Interface Description</strong></p> <p>Delete Domain Name</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>Long</p> </td> <td> <p>yes</p> </td> <td> <p>Domain Name id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>6. EnableOrDisableDomain</strong></p> <p><strong>Interface Description</strong></p> <p>Enable or Disable Domain</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>Long</p> </td> <td> <p>yes</p> </td> <td> <p>Domain id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>Response Parameter</p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>7. EnableOrDisableDomainResolve</strong></p> <p><strong>Interface Description</strong></p> <p>Enable or Disable Domain Resolution Record</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>RecordIDs</p> </td> <td> <p>String[]</p> </td> <td> <p>yes</p> </td> <td> <p>Selected recordID</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>EnableStatus</p> </td> <td> <p>yes</p> </td> <td> <p>Enable or Disable</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DomainName</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Domain Name</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>8. FindDomain</strong></p> <p><strong>Interface Description</strong></p> <p>Query Domain</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>DomainId</p> </td> <td> <p>Long</p> </td> <td> <p>yes</p> </td> <td> <p>Domain id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Domain</p> </td> <td> <p>DomainBean</p> </td> <td> <p>Domain<s> Found</s></p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>9. GetDomainRecordLine</strong></p> <p><strong>Interface Description</strong></p> <p>Query Domain Record Line Type</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>DomainName</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Domain Name of the line type</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>RecordLines</p> </td> <td> <p>List&lt;String&gt;</p> </td> <td> <p><s>Record </s>Line Type</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>10.&nbsp;GetDomainRecordType</strong></p> <p><strong>Interface Description</strong></p> <p>Query Domain Record Type</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>DomainName</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p><s>Query </s>Domain Name of the record type</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>RecordTypes</p> </td> <td> <p>List&lt;String&gt;</p> </td> <td> <p>Record Type</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>11.&nbsp;GetSubDomain</strong></p> <p><strong>Interface Description</strong></p> <p>Query all <s>domain </s>resolution records of a given domain</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>DomainId</p> </td> <td> <p>Long</p> </td> <td> <p>yes</p> </td> <td> <p>Query domain resolution record by domain id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>DomainResolves</p> </td> <td> <p>List&lt;DomainResolveBean&gt;</p> </td> <td> <p>Domain Resolution List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>12.&nbsp;ListDomainResolve</strong></p> <p><strong>Interface Description</strong></p> <p>Query Domain Resolution Record List</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>DomainId</p> </td> <td> <p>Long</p> </td> <td> <p>yes</p> </td> <td> <p>Query resolution record by Domain id</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>Page Number</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageSize</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>Page Size</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>DomainResolves</p> </td> <td> <p>List&lt;DomainResolveBean&gt;</p> </td> <td> <p>Domain Resolution List</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>Total Domain Resolution Count</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>13.&nbsp;ListDomains</strong></p> <p><strong>Interface Description</strong></p> <p>Query Domain List</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>PageNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>Page Number</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageSize</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>Page Size</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Domains</p> </td> <td> <p>List&lt;DomainBean&gt;</p> </td> <td> <p>Domain List</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>Total Domain Count</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>14.&nbsp;UpdateDomainResolve</strong></p> <p><strong>Interface Description</strong></p> <p>Update resolution record</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>Long</p> </td> <td> <p>yes</p> </td> <td> <p>Resolution Record id</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DomainName</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Domain Name of the Resolution Record</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SubDomain</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Instance record of the Resolution Record</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DomainType</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Domain Type of the Resolution Record</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>LineType</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Line Type of the Resolution Record</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RecordValue</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Record Value of the Resolution Record</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Weights</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>Weight</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>MxPriority</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>MX Priority</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Priority</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Priority</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Ttl</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>Response Time</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>EnableStatus</p> </td> <td> <p>no</p> </td> <td> <p>Enable or Disable</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table>
Did the above content solve your problem? Yes No
Please complete information!

Call us

400-151-8800

Email us

cloud@pingan.com

Online customer service

Instant reply

Technical Support

cloud products