All Products
Document Center


Last Updated: Apr 17, 2018


The QueryTransferInByInstanceId API queries domain name transfer information by instance ID.

Request parameters

Parameter Type Required Sample value Description
InstanceId String Yes S20181T0WLI85212

Instance ID.

Lang String No en

Language of the error message returned by the API, which has the following enumerated values: zh (Chinese) and en (English). The default value is en.

UserClientIp String No

User IP address.

Response parameters

Parameter Type Sample value Description
RequestId String AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60

The unique request ID.

SubmissionDate String 2018-03-28 00:41:42

Transfer request submission time.

ModificationDate String 2018-03-28 00:41:42

Transfer information update time.

UserId String 123456

User ID.

InstanceId String S20181T0WLI85212

Instance ID.

DomainName String

Domain name.

Status Integer 11

Detailed domain name transfer status, with the following enumerated values:

  • 10: Initial status.
  • 11: Email verification token link sent.
  • 19: Token link verification successful.
  • 20: Submitted for name verification.
  • 21: Name verification failed.
  • 29: Name verification successful.
  • 31: Incorrect transfer authorization code.
  • 39: Transfer submission successful.
  • 50: Transfer cancelled by customer.
  • 51: Transfer failed.
  • 52: Transfer expired.
  • 59: Transfer successful.
SimpleTransferInStatus String SUCCESS

Transfer status, with the following enumerated values:

  • INIT: Transfer submitted.
  • AUTHORIZATION: Transfer authorization (email verification).
  • NAME_VERIFICATION: Name verification.
  • PASSWORD_VERIFICATION: Transfer authorization code verification.
  • PENDING: Transfer in progress.
  • SUCCESS: Transfer successful.
  • FAIL: Transfer failed.
ResultCode String clientCancelled

The failure code returned when a transfer fails, with the following enumerated values:

  • clientCancelled: You cancelled this transfer.
  • clientRejected: The original domain name registrar rejected the transfer (or you rejected the operation at the original registrar).
  • serverCancelled: The registry cancelled the transfer.
  • transferProhibited: The domain name status does not permit a transfer.
  • transferExpired: You did not complete the transfer within the effective period.
  • nameVerificationFailed: The domain name did not pass name verification.
  • transferSubmitted: Another user has already submitted a domain name transfer.
ResultDate String 2018-03-28 00:41:42

Time of transfer success or failure.

ResultMsg String You have cancelled this domain name transfer

The transfer description returned when a transfer fails.

TransferAuthorizationCodeSubmissionDate String 2018-03-28 00:41:42

Transfer authorization code submission time.

NeedMailCheck Boolean true

Whether email verification is required.

Email String

The address to which the domain name transfer confirmation email is sent.

WhoisMailStatus Boolean true

Whether the domain name registrant’s email is crawled by WHOIS. If this field is false for an authorized domain name transfer (email verification), it indicates that the registrant’s email is not crawled by WHOIS and must be manually entered.

ExpirationDate String 2018-03-28 00:41:42

Domain name transfer expiration time.

ProgressBarType Integer 0

The transfer progress bar type, with the following enumerated values:

  • 0: Requires both email verification and name verification.
  • 1: Requires email verification, but not name verification.
  • 2. Requires name verification, but not email verification.
  • 3: Does not require email verification or name verification.
SubmissionDateLong Long 1514428524669

Transfer request submission timestamp.

ModificationDateLong Long 1514428524669

Transfer information update timestamp.

ResultDateLong Long 1514428524669

Timestamp of transfer success or failure.

ExpirationDateLong Long 1514428524669

Domain name transfer expiration timestamp.

TransferAuthorizationCodeSubmissionDateLong Long 1514428524669

Transfer authorization code submission timestamp.


Request example

  1. /?Action=QueryTransferInByInstanceId
  2. &InstanceId=S20181T0WLI85212
  3. &<Public request parameter>

Normal response example

  • XML format
  1. <QueryTransferInByInstanceIdResponse>
  2. <InstanceId>S20182F0RED000000</InstanceId>
  3. <WhoisMailStatus>true</WhoisMailStatus>
  4. <UserId>123456</UserId>
  5. <ResultDate>2018-03-28 09:54:39</ResultDate>
  6. <ExpirationDate>2018-04-12 09:51:53</ExpirationDate>
  7. <NeedMailCheck>true</NeedMailCheck>
  8. <Status>50</Status>
  9. <Email/>
  10. <SimpleTransferInStatus>FAIL</SimpleTransferInStatus>
  11. <ResultMsg>You have canceled this domain name transfer in.</ResultMsg>
  12. <RequestId>0D6108ED-7BB3-4898-83D0-44883DE0D3E7</RequestId>
  13. <ModificationDate>2018-03-28 09:54:39</ModificationDate>
  14. <ResultCode>clientCancelled</ResultCode>
  15. <DomainName></DomainName>
  16. <ProgressBarType>0</ProgressBarType>
  17. <SubmissionDate>2018-03-28 09:51:53</SubmissionDate>
  18. </QueryTransferInByInstanceIdResponse>
  • JSON format
  1. {
  2. "DomainName":"",
  3. "Email":"",
  4. "ExpirationDate":"2018-04-12 09:51:53",
  5. "InstanceId":"S20182F0RED000000",
  6. "ModificationDate":"2018-03-28 09:54:39",
  7. "NeedMailCheck":true,
  8. "ProgressBarType":0,
  9. "RequestId":"B3E437A1-4947-4E4F-B9E2-9781AB1C8134",
  10. "ResultCode":"clientCancelled",
  11. "ResultDate":"2018-03-28 09:54:39",
  12. "ResultMsg":"You have canceled this domain name transfer in.",
  13. "SimpleTransferInStatus":"FAIL",
  14. "Status":50,
  15. "SubmissionDate":"2018-03-28 09:51:53",
  16. "UserId":"123456",
  17. "WhoisMailStatus":true
  18. }

Abnormal response example

  • XML format
  1. <Error>
  2. <RequestId>41187FF2-262D-4414-8AD2-7B85D74E1385</RequestId>
  3. <HostId></HostId>
  4. <Code>MissingInstanceId</Code>
  5. <Message>InstanceId is mandatory for this action.</Message>
  6. <Recommend><![CDATA[]]></Recommend>
  7. </Error>
  • JSON format
  1. {
  2. "Code":"MissingInstanceId",
  3. "HostId":"",
  4. "Message":"InstanceId is mandatory for this action.",
  5. "Recommend":"",
  6. "RequestId":"05973664-CD29-4CF5-8060-FAC3E2CE0D87"
  7. }

Error code

See error codes of this product.