Submits a task for redeeming a domain name.

You can call the QueryTaskDetailList operation to query the task execution result.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes SaveSingleTaskForCreatingOrderRedeem

The operation that you want to perform. Set the value to SaveSingleTaskForCreatingOrderRedeem.

CurrentExpirationDate Long Yes 0000

The expiration time of the domain name. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

DomainName String Yes example.com

The domain name that you want to redeem.
UserClientIp String No 127.0.0.1

The IP address of the client that you use to redeem the domain name.
Lang String No en

The language of the error message to return. Valid values:

  • zh: Chinese
  • en: English

Default value: en.

UseCoupon Boolean No false

Specifies whether to use a voucher.
CouponNo String No 123123

The ID of the voucher to be used.
UsePromotion Boolean No false

Specifies whether to use a coupon.
PromotionNo String No 123123

The ID of the coupon to be used.

Response parameters

Parameter Type Example Description
RequestId String 40F46D3D-F4F3-4CCB-AC30-2DD20E32E528

The ID of the request.
TaskNo String 3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8

The ID of the task that was submitted.

Examples

Sample requests

http(s)://domain.aliyuncs.com/? Action=SaveSingleTaskForCreatingOrderRedeem
&CurrentExpirationDate=0000
&DomainName=example.com
&<Common request parameters>

Sample success responses

XML format 

<SaveSingleTaskForCreatingOrderRedeemResponse>
      <TaskNo>3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8</TaskNo>
      <RequestId>40F46D3D-F4F3-4CCB-AC30-2DD20E32E528</RequestId>
</SaveSingleTaskForCreatingOrderRedeemResponse>

JSON format 

{    
  "TaskNo": "3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8",
  "RequestId": "40F46D3D-F4F3-4CCB-AC30-2DD20E32E528"
}

Error codes

For a list of error codes, visit the API Error Center.