Submits a task for registering a domain name.

Description

Since March 1, 2022, you can register domain names only by using a registrant profile that has passed real-name verification. You can no longer register domain names by specifying registrant information.

To register a domain name, you must specify the domain name, domain name registrant, and Domain Name System (DNS) server. You can specify the domain name registrant by specifying the ID of a registrant profile. By default, Alibaba Cloud DNS servers are used. You can also use custom DNS servers.

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 SaveSingleTaskForCreatingOrderActivate

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

DomainName String Yes example.com

The domain name that you want to register.

Note You must specify the domain name registrant when you register a domain name. The domain name fails to be registered if no domain name registrant is specified. You can specify the domain name registrant by specifying the ID of a registrant profile in the RegistrantProfileId parameter.
RegistrantProfileId Long No 123

The ID of the registrant profile. The profile includes information such as the name of the domain name registrant, the contact for the domain name, phone number, and email address. You can specify the domain name registrant only by specifying the ID of the registrant profile. If you have created a registrant profile, you can call the QueryRegistrantProfiles operation to query the ID of the registrant profile.

Note If this parameter is specified, you do not need to specify the following parameters: RegistrantType, ZhRegistrantOrganization, ZhRegistrantName, ZhProvince, ZhCity, ZhAddress, RegistrantOrganization, RegistrantName, Province, City, Address, PostalCode, Country, TelArea, Telephone, TelExt, and Email.
RegistrantType String No 1

The type of the domain name registrant. Valid values:

  • 1: individual
  • 2: enterprise or organization
Note This parameter takes effect only when the RegistrantProfileId parameter is not specified. In this case, you must specify this parameter. The domain name fails to be registered if this parameter is not specified.
ZhRegistrantOrganization String No Test

The Chinese name of the domain name registrant.

Note This parameter applies only to the Domains service at the Alibaba Cloud China site (aliyun.com). This parameter takes effect only when the RegistrantProfileId parameter is not specified. In this case, you must specify this parameter. The domain name fails to be registered if this parameter is not specified.
ZhRegistrantName String No Test

The Chinese name of the domain name contact.

Note This parameter applies only to the Domains service at the Alibaba Cloud China site (aliyun.com). This parameter takes effect only when the RegistrantProfileId parameter is not specified. In this case, you must specify this parameter. The domain name fails to be registered if this parameter is not specified.
ZhProvince String No Bei Jing

The province where the domain name registrant is located, in Chinese.

Note This parameter applies only to the Domains service at the Alibaba Cloud China site (aliyun.com). This parameter takes effect only when the RegistrantProfileId parameter is not specified. In this case, you must specify this parameter. The domain name fails to be registered if this parameter is not specified.
ZhCity String No Bei Jing

The city where the domain name registrant is located, in Chinese.

Note This parameter applies only to the Domains service at the Alibaba Cloud China site (aliyun.com). This parameter takes effect only when the RegistrantProfileId parameter is not specified. In this case, you must specify this parameter. The domain name fails to be registered if this parameter is not specified.
ZhAddress String No Chao Yang

The address of the domain name registrant, in Chinese.

Note This parameter applies only to the Domains service at the Alibaba Cloud China site (aliyun.com). This parameter takes effect only when the RegistrantProfileId parameter is not specified. In this case, you must specify this parameter. The domain name fails to be registered if this parameter is not specified.
RegistrantOrganization String No Test

The English name of the domain name registrant.

Note This parameter takes effect only when the RegistrantProfileId parameter is not specified. In this case, you must specify this parameter. The domain name fails to be registered if this parameter is not specified.
RegistrantName String No Test

The English name of the domain name contact.

Note This parameter takes effect only when the RegistrantProfileId parameter is not specified. In this case, you must specify this parameter. The domain name fails to be registered if this parameter is not specified.
Province String No Bei Jing

The province where the domain name registrant is located, in English.

Note This parameter takes effect only when the RegistrantProfileId parameter is not specified. In this case, you must specify this parameter. The domain name fails to be registered if this parameter is not specified.
City String No Bei Jing

The city where the domain name registrant is located, in English.

Note This parameter takes effect only when the RegistrantProfileId parameter is not specified. In this case, you must specify this parameter. The domain name fails to be registered if this parameter is not specified.
Address String No Chao Yang

The address of the domain name registrant, in English.

Note This parameter takes effect only when the RegistrantProfileId parameter is not specified. In this case, you must specify this parameter. The domain name fails to be registered if this parameter is not specified.
PostalCode String No 1234567

The postal code of the area where the domain name registrant is located.

Note This parameter takes effect only when the RegistrantProfileId parameter is not specified. In this case, you must specify this parameter. The domain name fails to be registered if this parameter is not specified.
Country String No CN

The code of the country or region where the domain name registrant is located, such as CN.

Note This parameter takes effect only when the RegistrantProfileId parameter is not specified. In this case, you must specify this parameter. The domain name fails to be registered if this parameter is not specified.
TelArea String No 86

The international telephone code of the country or region where the domain name contact is located. For example, the international telephone code of China is 86.

Note This parameter takes effect only when the RegistrantProfileId parameter is not specified. In this case, you must specify this parameter. The domain name fails to be registered if this parameter is not specified.
Telephone String No 12345678

The phone number of the domain name registrant.

Note This parameter takes effect only when the RegistrantProfileId parameter is not specified. In this case, you must specify this parameter. The domain name fails to be registered if this parameter is not specified.
TelExt String No 1234

The extension number of the phone number of the domain name registrant.

Note This parameter takes effect only when the RegistrantProfileId parameter is not specified. In this case, you must specify this parameter. The domain name fails to be registered if this parameter is not specified.
Email String No username@example.com

The email address of the domain name registrant.

Note This parameter takes effect only when the RegistrantProfileId parameter is not specified. In this case, you must specify this parameter. The domain name fails to be registered if this parameter is not specified.
AliyunDns Boolean No true

Specifies whether to use Alibaba Cloud DNS servers. Valid values: true and false. Default value: true.

Note
  • If this parameter is set to true, you do not need to specify the Dns1 or Dns2 parameter. In this case, if the Dns1 or Dns2 parameter is specified, it does not take effect.
  • If this parameter is set to false, you must specify the Dns1 and Dns2 parameters.
Dns1 String No ns1.aliyun.com

The custom DNS server 1.

Note
  • This parameter takes effect only when the AliyunDns parameter is set to false. In this case, you must specify this parameter.
  • Make sure that the custom DNS server is valid. Otherwise, the registration may fail.
Dns2 String No ns2.aliyun.com

The custom DNS server 2.

Note
  • This parameter takes effect only when the AliyunDns parameter is set to false. In this case, you must specify this parameter.
  • Make sure that the custom DNS server is valid. Otherwise, the registration may fail.
PermitPremiumActivation Boolean No false

Specifies whether to allow registration of domain names that contain premium words. Valid values:

  • false: allows registration of domain names that contain premium words.
  • true: does not allow registration of domain names that contain premium words.

Default value: false.

PromotionNo String No 123123

The ID of the coupon that you want to use.

SubscriptionDuration Integer No 1

The subscription duration of the domain name. Unit: years. Default value: 1. Maximum value: 10.

EnableDomainProxy Boolean No false

Specifies whether to enable the domain name proxy service for the domain name. Valid values:

  • true: enables the domain name proxy service for the domain name.
  • false: disables the domain name proxy service for the domain name.

Default value: true.

UsePromotion Boolean No false

Specifies whether to use a coupon. Valid values:

  • false: uses a coupon.
  • true: does not use a coupon.

Default value: false.

TrademarkDomainActivation Boolean No false

Specifies whether to allow registration of domain names that contain trademark words. Valid values:

  • false: allows registration of domain names that contain trademark words.
  • true: does not allow registration of domain names that contain trademark words.
UseCoupon Boolean No false

Specifies whether to use a voucher. Valid values:

  • true: uses a voucher.
  • false: does not use a voucher.

Default value: false.

CouponNo String No 123456

The ID of the voucher that you want to use. By default, the value of this parameter is a string.

Lang String No en

The language in which the system returns the error message. Valid values:

  • zh: Chinese
  • en: English

Default value: en.

UserClientIp String No 127.0.0.1

The IP address of the client that you use to register the domain name. You can set this parameter to 127.0.0.1.

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.

Examples

Sample requests

http://domain.aliyuncs.com/?Action=SaveSingleTaskForCreatingOrderActivate
&RegistrantProfileId=123
&DomainName=example.com
&<Common request parameters>

Sample success responses

XML format

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

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.