Submits a task for registering a domain name.

Description

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 or manually entering the information about the registrant. 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 test.com

The domain name that you want to register.

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 use the RegistrantProfileId parameter to specify a registrant profile or use parameters such as RegistrantType and ZhRegistrantOrganization to define a domain name registrant.

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. We recommend that you use a registrant profile to specify the domain name registrant when you register a domain name. 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 only takes effect 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 is only applicable to the Domains service on the Alibaba Cloud China website (aliyun.com). This parameter only takes effect 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 contact for the domain name.

Note This parameter is only applicable to the Domains service on the Alibaba Cloud China website (aliyun.com). This parameter only takes effect 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 Beijing

The Chinese name of the province where the domain name registrant is located.

Note This parameter is only applicable to the Domains service on the Alibaba Cloud China website (aliyun.com). This parameter only takes effect 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 Beijing

The Chinese name of the city where the domain name registrant is located.

Note This parameter is only applicable to the Domains service on the Alibaba Cloud China website (aliyun.com). This parameter only takes effect 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 Chaoyang District

The Chinese name of the address of the domain name registrant.

Note This parameter is only applicable to the Domains service on the Alibaba Cloud China website (aliyun.com). This parameter only takes effect 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 ce shi

The name of the domain name registrant.

Note This parameter only takes effect 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 ce shi

The name of the contact for the domain name.

Note This parameter only takes effect 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.

Note This parameter only takes effect 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 shi

The city where the domain name registrant is located.

Note This parameter only takes effect 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 qu

The address of the domain name registrant.

Note This parameter only takes effect 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 zip code of the region where the domain name registrant is located.

Note This parameter only takes effect 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/region where the domain name registrant is located, such as CN.

Note This parameter only takes effect 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 calling code of the country/region where the domain name registrant is located. For example, the calling code for China is 86.

Note This parameter only takes effect 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 only takes effect 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 registrant's phone number.

Note This parameter only takes effect 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 test@aliyun.com

The email address of the domain name registrant.

Note This parameter only takes effect 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 the value is set to true, you do not need to specify the Dns1 and Dns2 parameters. If the Dns1 and Dns2 parameters are specified, they do not take effect.
  • If the value is set to false, you need to specify the Dns1 and Dns2 parameters.
Dns1 String No ns1.aliyun.com

The custom DNS server 1.

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

The custom DNS server 2.

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

The language of the error message to return. 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 domain names.

SubscriptionDuration Integer No 1

The validity period of the domain name. Unit: year. Default value: 1.

EnableDomainProxy Boolean No false

Specifies whether to enable the domain name proxy service for the domain name. Default value: true.

PermitPremiumActivation Boolean No false

Specifies whether to allow registration of domain names that contain premium words. Default value: false.

TrademarkDomainActivation Boolean No false

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

UseCoupon Boolean No false

Specifies whether to use a voucher.

CouponNo String No 123456

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://domain.aliyuncs.com/?Action=SaveSingleTaskForCreatingOrderActivate
&RegistrantProfileId=123
&DomainName=test.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.