# Alibaba Cloud Domain API

> Alibaba Cloud Domain API on Apizie: 128 endpoints (Confirms the result of a task detail, Checks whether domain names contain sensitive words in batches, Cancels the real-name verification audit for a domain name, Cancels a self-service business audit, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:aliyun-domain/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-domain`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/domain
- Page: https://www.apizie.tech/api/cloud/aliyun-domain
- OpenAPI: https://www.apizie.tech/api/cloud/aliyun-domain/openapi.json

Alibaba Cloud OpenAPI for Domain (domain, version 2018-01-29). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Confirms the result of a task detail
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/acknowledge-task-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | User IP address |
| Lang | string | no | Language of the error message returned by the API. Valid values: zh: Chinese; en: English. Default value: en |
| TaskDetailNo | string | yes | List of task detail numbers (JSON-encoded) |

### Checks whether domain names contain sensitive words in batches
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/batch-fuzzy-match-domain-sensitive-word` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Keyword | string | yes | The domain name keywords. Separate multiple keywords with commas (,) |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| UserClientIp | string | no | The IP address of the user |

### Cancels the real-name verification audit for a domain name
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/cancel-domain-verification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The user IP address. You can set this parameter to 127.0.0.1 |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| InstanceId | string | yes | The ID of the domain name instance. You can obtain the ID by calling the https://help.aliyun.com/document_detail/67712.html operation |
| ActionType | string | yes | The type of the operation. Valid values: DOMAINAUDIT: Domain name audit. AUDITCONTACT: Contact audit |

### Cancels a self-service business audit
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/cancel-operation-audit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| AuditRecordId | integer | yes | The ID of the audit record. You can call the https://help.aliyun.com/document_detail/172568.html operation to query the audit record ID |

### Cancel the qualification verification for ".restaurant" and ".trademark" domain names.
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/cancel-qualification-verification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | Language of the error message returned by the API. Valid values: zh: Chinese en: English Default value: en. |
| UserClientIp | string | no | User IP address. |
| InstanceId | string | yes | Domain name instance ID. |
| QualificationType | string | yes | Qualification verification API type. The value is fixed as knet. |

### Cancels an ongoing task
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/cancel-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | User IP address |
| Lang | string | no | Language of the error message returned by the API. Valid values: zh: Chinese. en: English. Default value: en |
| TaskNo | string | yes | Job number. You can query the job number by using the https://help.aliyun.com/document_detail/67709.html API |

### Modifies the resource group to which a domain name belongs
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the client |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: zh |
| ResourceId | string | yes | The ID of the domain name resource |
| NewResourceGroupId | string | yes | The ID of the destination resource group. You can view the resource group ID in the Resource Management console… |
| ResourceType | string | no | The type of the domain name resource. Set the value to Domain. You do not need to specify this parameter |

### Checks whether a domain name can be registered
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/check-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The domain name |
| FeeCommand | string | no | The operation command. Valid values: create: Registration. renew: Renewal. transfer: Transfer-in. restore: Redemption |
| FeeCurrency | string | no | The currency type. Valid values: USD (US dollar) |
| FeePeriod | integer | no | The subscription period in years. Valid values: 1 to 10 |
| Lang | string | no | The language of the error message returned by the operation. Valid values: zh: Chinese. en: English. Default value: en |

### Query the trademark keyword key based on the provided domain name
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/check-domain-sunrise-claim` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The domain name to query |
| Lang | string | no | Language of error messages returned by the API. Valid values: zh: Chinese; en: English. Default value is en |
| UserClientIp | string | no | User IP address. You can set it to 127.0.0.1 |

### Checks the status and price of international fixed-price domain names on sale
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/check-intl-fix-price-domain-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Domain | string | no | The domain name |

### Checks the maximum number of years for which a domain name can be purchased or renewed
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/check-max-year-of-server-lock` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The domain name to be checked |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese en: English Default value: en |
| UserClientIp | string | no | The IP address of the user |
| CheckAction | string | yes | The service type to purchase. Valid values: activate: New registration renew: Renewal |

### Checks whether a registry lock application for a domain name is in the processing state
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/check-processing-server-lock-apply` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| FeePeriod | integer | no | The subscription period in years. Valid values: 1 to 10 |
| DomainName | string | yes | The domain name to check |
| Lang | string | no | The language of the error message returned by the API. Valid values: zh: Chinese en: English Default value: en |
| UserClientIp | string | no | The client IP address. You can set this parameter to 127.0.0.1 |

### Checks whether a domain name can be transferred in
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/check-transfer-in-feasibility` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| UserClientIp | string | no | The IP address of the client. You can set this parameter to 127.0.0.1 |
| DomainName | string | yes | The domain name to be checked |
| TransferAuthorizationCode | string | no | The transfer authorization code of the domain name |

### Confirms the transfer-in email address
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/confirm-transfer-in-email` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the user |
| Lang | string | no | The language of the error message returned by the API. Valid values: zh: Chinese. en: English. Default value: en |
| Email | string | yes | The email address |
| DomainName | string | yes | The list of domain names (JSON-encoded) |

### Creates an international fixed-price domain name order
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/create-intl-fixed-price-domain-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Domain | string | no | The domain name |
| ContactId | integer | no | The ID of the contact |
| ExpectedPrice | integer | no | The expected price |
| AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: false: manual payment. This is the default value. true: automatic payment |
| ProductType | integer | no | The ProductType |

### Deletes multiple domain name registrant profiles
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/delete-contact-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |
| RegistrantProfileIds | string | yes | The IDs of the registrant profiles to be deleted. Separate multiple IDs with commas (,). A registrant profile ID is automatically… |

### Deleting a group containing more than 1,000 domain names is an asynchronous procedure. You must wait for the…
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/delete-domain-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | User IP address. You can set it to 127.0.0.1 |
| Lang | string | no | Language of the error message returned by the API. Valid values: zh: Chinese en: English Default value: en |
| DomainGroupId | integer | yes | Domain name group ID. You can obtain it by using the https://help.aliyun.com/document_detail/69362.html API |

### Deletes email addresses that have passed email verification
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/delete-email-verification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| Email | string | yes | The email addresses to be deleted. Separate multiple email addresses with commas (,) |
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |

### Deletes a specified domain name registrant profile
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/delete-registrant-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The User IP address. You can set it to 127.0.0.1. |
| Lang | string | no | The language of the error message returned by the API. Valid values: zh: Chinese. en: English. Default value: en. |
| RegistrantProfileId | integer | yes | The ID of the domain name registrant profile to delete. You can call the https://help.aliyun.com/document_detail/67701.html API to query… |

### Queries the domain name knowledge base
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/domain-knowledge-retrieve` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Keyword | string | yes | Keywords to be retrieved |
| Site | string | no | Search knowledge base sites, including domestic cn, international intl, and all |
| GlobalTopN | integer | no | The number of retrieve results that need to be returned |

### 取消域名特殊业务流程
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/domain-special-biz-cancel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BizId | integer | yes | 业务id |
| UserClientIp | string | no | The UserClientIp |

### Checks whether a domain name contains sensitive words
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/fuzzy-match-domain-sensitive-word` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Keyword | string | yes | The domain name keyword, which refers to the words in the domain name excluding the suffix. Separate multiple keywords with commas (,) |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |

### Retrieves the URL for the list of international fixed-price domain names for sale
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/get-intl-fix-price-domain-list-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ListDate | string | no | The date of the file |

### Retrieves the storage information for audit materials
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/get-operation-oss-upload-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the error message returned by the API. Valid values: zh: Chinese. en: English. Default value: en |
| AuditType | integer | yes | The audit type. Valid values: 1: Offline domain name transfer |

### Retrieves the authorization policies for ".restaurant" and ".trademark" domain names
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/get-qualification-upload-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese en: English Default value: en |
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |

### Queries the email verification list
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/list-email-verification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the error message returned by the API. Valid values: zh: Chinese. en: English. Default value: en |
| BeginCreateTime | integer | no | The start time for querying email verifications. The time is specified as the number of milliseconds that have elapsed since 00:00:00 UTC… |
| EndCreateTime | integer | no | The end time for querying email verifications. The time is specified as the number of milliseconds that have elapsed since 00:00:00 UTC on… |
| Email | string | no | The email address to be queried. You can specify only one email address at a time |
| VerificationStatus | integer | no | The email verification status. Valid values: 0: Pending verification. 1: Verified |
| PageNum | integer | no | The page number of the list. Default value: 1. You can set this parameter as needed |
| PageSize | integer | no | The number of entries per page. Default value: 500. Maximum value: 5000. You can set this parameter as needed |
| UserClientIp | string | no | The IP address of the client. You can set this parameter to 127.0.0.1 |

### Queries the registry lock list for domain names
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/list-server-lock` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | no | The domain name to query |
| EndStartDate | integer | no | The end time for the query |
| BeginStartDate | integer | no | The start time for the query |
| PageNum | integer | no | The page number of the domain name list |
| PageSize | integer | no | The page size |
| Lang | string | no | The language of the error message returned by the API. Valid values: zh: Chinese en: English Default value: en |
| LockProductId | string | no | The ID of the lock product |
| ServerLockStatus | integer | no | The registry lock status. Valid values: 1: not enabled 2: enabled 3: disabled |
| StartExpireDate | integer | no | The start of the expiration time range |
| EndExpireDate | integer | no | The end of the expiration time range |
| OrderBy | string | no | The sort field |
| OrderByType | string | no | The sort order for business content, such as registration time and expiration time. Valid values: ASC: ascending order DESC: descending… |
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |

### Queries Trademark Clearinghouse (TMCH) information based on the specified claim key
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/lookup-tmch-notice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClaimKey | string | yes | The claim key of the domain name. You can obtain the claim key by calling the CheckDomainSunriseClaim… |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| UserClientIp | string | no | The IP address of the client. You can set this parameter to 127.0.0.1 |

### Queries the details of completed domain name tasks, including tasks that succeeded and tasks that failed…
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/poll-task-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| TaskNo | string | no | The task ID |
| DomainName | string | no | The domain name |
| InstanceId | string | no | The ID of the domain name instance. The ID is automatically generated by the system after a domain name registrant profile is created. You… |
| TaskResultStatus | integer | no | The task result type. Valid values: 2: Successful. 3: Failed |
| PageNum | integer | yes | The page number |
| PageSize | integer | yes | The number of entries per page. Maximum value: 1000 |

### Performs an advanced search of the domain name list
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-advanced-domain-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| EndExpirationDate | integer | no | End time for expiration date range query, represented as the number of milliseconds since 00:00:00 UTC on January 1, 1970. |
| UserClientIp | string | no | User IP address |
| Lang | string | no | The language of error messages returned by the API. Valid values: zh: Chinese. en: English. Default value: en |
| StartExpirationDate | integer | no | Start time for expiration date range query, represented as the number of milliseconds since 00:00:00 UTC on January 1, 1970. |
| ProductDomainType | string | no | Domain name type. Valid values: New gTLD (new top-level domain). gTLD (generic top-level domain). ccTLD (country code top-level domain).… |
| PageNum | integer | yes | Page number for paging. The minimum value is 0. |
| PageSize | integer | yes | Page size for paging. The minimum value is 1 and the maximum value is 200. |
| DomainGroupId | integer | no | Domain group ID. |
| DomainNameSort | string | no | Sorting field based on lexicographic order of domain names. Valid values: false: Descending order true: Ascending order |
| DomainStatus | integer | no | Domain status. Valid values: 0: All. 1: Renewal required urgently. 2: Redemption required urgently. 3: Normal. 4: Transferring out from… |
| EndLength | integer | no | End length for domain name length range query. |
| Excluded | string | no | Excluded keyword. |
| ExcludedPrefix | string | no | Keyword to exclude at the beginning |
| ExcludedSuffix | string | no | Keyword to exclude at the end |
| ExpirationDateSort | string | no | Sorting field based on expiration date. Valid values: false: Descending order. true: Ascending order |
| Form | integer | no | Domain name composition information: 11: Numeric-only domain name 12: Letter-only domain name 13: Mixed domain name (combination of… |
| KeyWord | string | no | Keyword |
| KeyWordPrefix | string | no | Keyword at the beginning |
| KeyWordSuffix | string | no | Keyword at the end |
| ProductDomainTypeSort | string | no | Sorting field, used to sort by domain name type. Valid values: false: Descending order. true: Ascending order |
| RegistrationDateSort | string | no | Sorting field based on registration date. Valid values: false: Descending order. true: Ascending order |
| StartLength | integer | no | The starting length for domain name length range queries |
| TradeType | integer | no | Publishing status. Valid values: 2: Fixed-price listing published 13: Negotiable-price listing published 4: Auction listing published 6:… |
| Suffixs | string | no | List of suffixes to query, separated by commas (",") |
| StartRegistrationDate | integer | no | The start time of the registration date range query, expressed as the number of milliseconds since 00:00 on January 1, 1970, UTC |
| EndRegistrationDate | integer | no | The end time of the registration date range query, expressed as the number of milliseconds since 00:00 on January 1, 1970, UTC |
| ResourceGroupId | string | no | Resource group ID. |
| Tag | string | no | List of tags (JSON-encoded) |
| IsPremiumDomain | string | no | Indicates whether the domain is a premium domain. Valid values: false: No true: Yes Default value: false. |

### Queries the information about an Art extension
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-art-extension` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | Domain name. |
| Lang | string | no | Language of error messages returned by the API. Valid values: zh: Chinese. en: English. Default value: en. |
| UserClientIp | string | no | User IP address. |

### Queries the operation logs under your current Alibaba Cloud account by page
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-change-log-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| DomainName | string | no | The domain name for which you want to query operation logs |
| PageNum | integer | yes | The page number. Minimum value: 1 |
| PageSize | integer | yes | The number of entries per page. Minimum value: 1. Maximum value: 100 |
| StartDate | integer | no | The start time of the time range to query. The value is a UNIX timestamp in milliseconds |
| EndDate | integer | no | The end time of the time range to query. The value is a UNIX timestamp in milliseconds |

### Queries the contact information of a domain name
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-contact-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | User IP address. |
| Lang | string | no | Language of error messages returned by the API. Valid values: zh: Chinese. en: English. Default value: en. |
| DomainName | string | yes | Domain name. |
| ContactType | string | yes | The contact type. Valid values: registrant: Domain name registrant. tech: Technical contact. admin: Administrative contact. billing:… |

### Queries the DS records of a domain name
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-dsrecord` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The domain name |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| UserClientIp | string | no | The IP address of the user |

### Queries the DNS host of a domain name
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-dns-host` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InstanceId | string | yes | The instance ID of the domain name. You can obtain the ID by calling the QueryDomainList operation |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| UserClientIp | string | no | The IP address of the user |

### Queries Chinese administrative regions
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-domain-admin-division` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | Language of the error message returned by the API. Valid values: zh: Chinese. en: English. Default value: en. |
| UserClientIp | string | no | User IP address. You can set it to 127.0.0.1. |

### Queries the information about a domain name by domain name
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-domain-by-domain-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the user |
| Lang | string | no | The language of the error message that is returned. Valid values: zh: Chinese. en: English. Default value: en |
| DomainName | string | yes | The domain name |

### Queries the basic information of a domain name by instance ID
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-domain-by-instance-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The user's IP address. You can use 127.0.0.1 |
| Lang | string | no | The language of API error messages. Valid values: zh: Chinese. en: English. Default value: en |
| InstanceId | string | yes | The domain instance ID. Call the https://help.aliyun.com/document_detail/67712.html API to get this ID |

### Queries a list of domain groups
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-domain-group-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of error messages in the response. Valid values: zh: Chinese en: English The default value is en |
| UserClientIp | string | no | The client IP address. You can set this parameter to 127.0.0.1 |
| DomainGroupName | string | no | The user-defined domain group name |
| ShowDeletingGroup | string | no | Specifies whether to show domain groups that are being deleted. Valid values: false true The default value is false |
| OrderKeyType | string | no | The OrderKeyType |
| OrderByType | string | no | The OrderByType |

### Returns a paginated list of domain names in your account
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-domain-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| EndExpirationDate | integer | no | The end of the expiration date range. The value is a Unix timestamp in milliseconds. Currently, only queries by day are supported |
| StartExpirationDate | integer | no | The start of the expiration date range. The value is a Unix timestamp in milliseconds. Currently, only queries by day are supported |
| UserClientIp | string | no | The user's client IP address. You can set this parameter to 127.0.0.1 |
| Lang | string | no | The language for API error messages. Valid values: zh: Chinese. en: English. The default value is en |
| QueryType | string | no | The type of list to return. Valid values: 1: Domain names that require urgent renewal. 2: Domain names that require urgent redemption |
| StartRegistrationDate | integer | no | The start of the registration date range. The value is a Unix timestamp in milliseconds. Currently, only queries by day are supported |
| EndRegistrationDate | integer | no | The end of the registration date range. The value is a Unix timestamp in milliseconds. Currently, only queries by day are supported |
| DomainName | string | no | The domain name to query |
| OrderByType | string | no | The sort order for the results. Valid values: ASC: Ascending. DESC: Descending. The default value is DESC |
| OrderKeyType | string | no | The field to use for sorting. Valid values: RegistrationDate: Sorts by registration date. ExpirationDate: Sorts by expiration date. By… |
| ProductDomainType | string | no | The domain type. Valid values: New gTLD: New generic top-level domain. gTLD: Generic top-level domain. ccTLD: Country-code top-level domain |
| PageNum | integer | yes | The page number for the paginated results |
| PageSize | integer | yes | The number of entries to return on each page |
| DomainGroupId | string | no | The ID of the domain group. You can obtain this ID by calling the https://help.aliyun.com/document_detail/69362.html operation. The ID of… |
| ResourceGroupId | string | no | The ID of the resource group |
| Tag | string | no | A list of tags (JSON-encoded) |
| Ccompany | string | no | The name of the domain owner |
| Registrar | string | no | The Registrar |
| Dns | string | no | The Dns |
| AutoRenewEnabled | string | no | 自动续费状态： true：已启用 false：未启用 |

### Queries the real-name verification information of a domain name
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-domain-real-name-verification-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | User IP address. |
| Lang | string | no | Language of error messages returned by the API. Valid values: zh: Chinese. en: English. Default value: en. |
| DomainName | string | yes | Domain name. |
| FetchImage | string | no | Specifies whether to retrieve the real-name verification image. Valid values: true: Retrieve the image. false: Do not retrieve the image. |

### 查询域名特殊业务详情
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-domain-special-biz-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BizId | integer | no | 业务id |
| UserClientIp | string | no | The UserClientIp |

### 通过域名查询域名特殊业务详情
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-domain-special-biz-info-by-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | 域名 |
| BizType | string | yes | 业务类型 |
| UserClientIp | string | no | The UserClientIp |

### Queries the available domain name suffixes
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-domain-suffix` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the error message in the API response. Valid values: zh: Chinese. en: English. Default value: en |
| UserClientIp | string | no | The user IP address |

### Queries the email verification result
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-email-verification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| Email | string | yes | The email address to query |
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |

### Queries the wallet address attached in the ENS system
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-ens-association` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | Domain name |
| Lang | string | no | Language of the error message returned by the API. Valid values: zh: Chinese. en: English. Default value: en |
| UserClientIp | string | no | User IP address |

### Queries the reasons for domain name real-name verification failures, including naming review failures
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-fail-reason-for-domain-real-name-verification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the user |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| DomainName | string | yes | The domain name |
| RealNameVerificationAction | string | yes | The review type. Valid values: ACTIVATE: New registration. CHGHOLDER: Ownership transfer. TRANSFER: Transfer-in |

### Queries the reason for the real-name verification failure of a registrant profile
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-fail-reason-for-registrant-profile-real-name-verificat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the client. You can set this parameter to 127.0.0.1 |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| RegistrantProfileID | integer | yes | The ID of the registrant profile that failed the real-name verification. You can call the… |

### Queries the reasons for qualification verification failures of ".restaurant" and ".trademark" domain names
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-failing-reason-list-for-qualification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| QualificationType | string | yes | The qualification verification API type. Set the value to knet |
| UserClientIp | string | no | The IP address of the user |
| Lang | string | no | The language of the error message returned by the API. Valid values: zh: Chinese en: English Default value: en |
| InstanceId | string | yes | The instance ID |
| Limit | integer | yes | The number of records to query |

### Queries the list of international fixed-price orders
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-intl-fixed-price-order-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BizId | string | no | The business ID |
| Status | integer | no | The status |
| CurrentPage | integer | no | The page number |
| PageSize | integer | no | The page size |

### Queries the ENS binding address recorded in the Alibaba Cloud system
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-local-ens-association` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | User IP |
| DomainName | string | yes | Domain name |
| Lang | string | no | Language of the error message returned by the API. Valid values: zh: Chinese; en: English. Default value: en |

### Queries the details of audit records for self-service operations
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-operation-audit-info-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| AuditRecordId | integer | yes | The ID of the audit record |

### Queries the audit records for self-service operations
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-operation-audit-info-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| DomainName | string | no | The domain name to query |
| AuditType | integer | no | The audit type. Valid values: 1: Offline domain name transfer |
| AuditStatus | integer | no | The audit status. Valid values: 0: Pending information completion. 1, 2, 3, 4: Under review. 5: Review failed. 6: Review succeeded. 7:… |
| PageSize | integer | no | The number of entries per page |
| PageNum | integer | no | The page number |

### Query the qualification verification details of ".restaurant" and ".trademark" domain names.
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-qualification-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InstanceId | string | yes | Instance ID. |
| UserClientIp | string | no | User IP address. |
| Lang | string | no | The language of the error message returned by the API. Valid values: zh: Chinese en: English Default value: en |
| QualificationType | string | yes | API type for qualification verification. Fixed value: knet. |

### Queries the real-name verification materials of a registrant profile
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-registrant-profile-real-name-verification-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |
| Lang | string | no | The language of the error message returned by the API. Valid values: zh: Chinese. en: English. Default value: en |
| RegistrantProfileId | integer | yes | The ID of the registrant profile to query. The ID is automatically generated by the system after the registrant profile is created. You… |
| FetchImage | string | no | Specifies whether to obtain the real-name verification image. Valid values: true: Obtain the image. false: Do not obtain the image.… |

### Queries the domain name registrant profiles under the current account
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-registrant-profiles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| RegistrantOrganization | string | no | The name of the domain name registrant in English |
| UserClientIp | string | no | The IP address of the client. You can set this parameter to 127.0.0.1 |
| RegistrantProfileId | integer | no | The ID of the registrant profile to be queried. The ID is automatically generated by the system after the registrant profile is created |
| DefaultRegistrantProfile | string | no | Specifies whether the registrant profile is the default profile. Valid values: true: The registrant profile is the default profile. false:… |
| PageNum | integer | no | The page number. Default value: 0 |
| PageSize | integer | no | The number of entries to return on each page. Default value: 0. Maximum value: 5000 |
| ZhRegistrantOrganization | string | no | The name of the domain name registrant in Chinese |
| RegistrantType | string | no | The type of the domain name registrant. Valid values: 1: Individual. 2: Enterprise. Default value: 1 |
| RealNameStatus | string | no | The real-name verification status. Valid values: FAILED: Real-name verification failed. SUCCEED: Real-name verification succeeded.… |
| Email | string | no | The email address |
| RegistrantProfileType | string | no | The template type of the registrant profile. Valid values: common: General template. cnnic: CNNIC template. CNNIC templates are supported… |
| Remark | string | no | The remark |

### Queries the details of the registry lock for a domain name
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-server-lock` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| InstanceId | string | no | The domain name instance ID |
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |

### Queries the detail history of a specified domain name task by page
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-task-detail-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | Language of error messages returned by the API. Valid values: zh: Chinese. en: English. Default value: en |
| UserClientIp | string | no | User IP address |
| TaskNo | string | yes | Job number. You can obtain the job number by calling the https://help.aliyun.com/document_detail/67709.html API |
| DomainName | string | no | Domain name |
| DomainNameCursor | string | no | Domain name cursor |
| TaskStatus | integer | no | Job status. Valid values: 0: Waiting to execute. 1: Executing. 2: Succeeded. 3: Failed |
| PageSize | integer | yes | Page size |
| TaskDetailNoCursor | string | no | Task detail cursor |

### Queries the details list of a specified domain name task by paging
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-task-detail-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TaskStatus | integer | no | The task status. Valid values: 0: Waiting to be executed. 1: Executing. 2: Successful. 3: Failed |
| Lang | string | no | The language of the error message returned by the operation. Valid values: zh: Chinese. en: English. Default value: en |
| TaskNo | string | yes | The task number. This is the TaskNo value returned by a successfully executed task |
| DomainName | string | no | The domain name |
| InstanceId | string | no | The domain name instance ID. You can call https://help.aliyun.com/document_detail/442021.html… |
| UserClientIp | string | no | The user IP address. You can set this parameter to 127.0.0.1 |
| PageNum | integer | yes | The page number |
| PageSize | integer | yes | The number of entries per page. Maximum value: 1000 |

### Queries the history list of domain name tasks under your account by using paging
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-task-info-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |
| Lang | string | no | The language of the error message returned by the API. Valid values: zh: Chinese. en: English. Default value: en |
| BeginCreateTime | integer | no | The start time of the creation date range to query. The time is calculated as the number of milliseconds that have elapsed since 00:00:00… |
| EndCreateTime | integer | no | The end time of the creation date range to query. The time is calculated as the number of milliseconds that have elapsed since 00:00:00… |
| PageSize | integer | yes | The number of entries per page |
| CreateTimeCursor | integer | no | The cursor for the creation date. This is a technical parameter |
| TaskNoCursor | string | no | The task cursor. Pass the task ID in the cursor of the corresponding page when you navigate to the next page. This is a technical parameter |

### Queries the list of domain name tasks under your account by page
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-task-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the user |
| Lang | string | no | The language of the error message returned by the API. Valid values: zh: Chinese. en: English. Default value: en |
| BeginCreateTime | integer | no | The start time of the creation date range for the query. The value is a timestamp in milliseconds that have elapsed since January 1, 1970,… |
| EndCreateTime | integer | no | The end time of the creation date range for the query. The value is a timestamp in milliseconds that have elapsed since January 1, 1970,… |
| PageNum | integer | yes | The page number |
| PageSize | integer | yes | The number of entries per page |

### Queries domain name transfer-in information by instance ID
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-transfer-in-by-instance-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InstanceId | string | yes | Instance ID |
| Lang | string | no | Language of the error message returned by the API. Valid values: zh: Chinese; en: English. Default value: en |
| UserClientIp | string | no | User IP address |

### Queries the domain name transfer-in list
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-transfer-in-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of error messages returned by the API. Valid values: zh: Chinese. en: English. Default value: en |
| UserClientIp | string | no | The user IP address, which can be set to 127.0.0.1 |
| SubmissionStartDate | integer | no | The start time for submitting the domain name list for transfer-in |
| SubmissionEndDate | integer | no | End time for submitting the domain name list for transfer-in. |
| DomainName | string | no | The domain name, which supports prefix matching (fuzzy query) |
| SimpleTransferInStatus | string | no | Transfer status. Valid values: INIT: Submit transfer-in. AUTHORIZATION: Authorize transfer-in (email verification). NAME_VERIFICATION:… |
| PageNum | integer | yes | The page number of the domain name list |
| PageSize | integer | yes | The page size for paging the domain name list |

### Queries domain name transfer-out information
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/query-transfer-out-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | Domain name. |
| Lang | string | no | Language of error messages returned by the API. Valid values: zh: Chinese; en: English. Default value: en. |
| UserClientIp | string | no | User IP address. |

### Submits real-name verification for a registrant profile
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/registrant-profile-real-name-verification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | User IP address. You can set it to 127.0.0.1 |
| Lang | string | no | Language for error messages returned by the API. Valid values: zh: Chinese. en: English. Default value is en |
| RegistrantProfileID | integer | yes | ID of the information template to undergo identity verification. This ID is automatically generated by the system after the information… |
| IdentityCredential | string | yes | Upload the Base64-encoded image of your identity verification documents. Image requirements: Format must be JPG or BMP. Original image… |
| IdentityCredentialNo | string | yes | Enter the certificate number used for identity verification. For example, an identity card number or business license number. The… |
| IdentityCredentialType | string | yes | Certificate type for identity verification. Select the certificate type you use for identity verification. Valid values: SFZ: Identity… |

### Resends the verification email
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/resend-email-verification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | Language of error messages returned by the API. Valid values: zh: Chinese. en: English. Default value: en |
| Email | string | yes | Mailboxes for which to resend the verification email. Separate multiple mailboxes with commas (,) |
| UserClientIp | string | no | User IP address. You can set it to 127.0.0.1 |

### Reset the qualification verification status for .restaurant and .trademark domain names.
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/reset-qualification-verification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InstanceId | string | yes | Domain name instance ID. |
| UserClientIp | string | no | User IP address. |
| Lang | string | no | Language of error messages returned by the API. Valid values: zh: Chinese en: English Default value is en. |

### Saves the remarks of multiple domain names at a time
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-batch-domain-remark` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | Language of the error message returned by the API. Valid values: zh: Chinese; en: English. Default value: en. This parameter is Required. |
| Remark | string | no | Remark information. |
| InstanceIds | string | yes | List of instance IDs. We recommend grouping them in sets of 10, with a maximum of 50 per group, separated by commas (,). |
| UserClientIp | string | no | User IP address, which can be set to 127.0.0.1. |

### Submits a batch task to quickly transfer out domain names
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-batch-task-for-apply-quick-transfer-out-openly` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainNames | string | no | The domain names to transfer out (JSON-encoded) |
| Lang | string | no | The language of returned error messages. Valid values: zh (Chinese) and en (English). Default value: en |
| UserClientIp | string | no | The IP address of the user's client |

### Submits a batch domain name registration task
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-batch-task-for-creating-order-activate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the user |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| CouponNo | string | no | The voucher ID |
| UseCoupon | string | no | Specifies whether to use a voucher |
| PromotionNo | string | no | The coupon ID |
| UsePromotion | string | no | Specifies whether to use a coupon |
| OrderActivateParam | string | yes | The list of task details (JSON-encoded) |

### Submits a batch domain name redemption task
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-batch-task-for-creating-order-redeem` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | User IP address. You can set it to 127.0.0.1. |
| Lang | string | no | Language of error messages returned by the API. Valid values: zh: Chinese; en: English. Default value: en. |
| CouponNo | string | no | Coupon number. |
| UseCoupon | string | no | Is coupon used? Valid values: false: No. true: Yes. |
| PromotionNo | string | no | Coupon number. |
| UsePromotion | string | no | Is coupon used? Valid values: false: No. true: Yes. |
| OrderRedeemParam | string | yes | List of job details. (JSON-encoded) |

### Submits a batch domain name renewal task
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-batch-task-for-creating-order-renew` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| CouponNo | string | no | The voucher ID |
| UseCoupon | string | no | Specifies whether to use a voucher. Valid values: false: Does not use a voucher. true: Uses a voucher |
| PromotionNo | string | no | The coupon ID |
| UsePromotion | string | no | Specifies whether to use a coupon. Valid values: false: Does not use a coupon. true: Uses a coupon |
| OrderRenewParam | string | yes | The list of parameters for domain name renewal (JSON-encoded) |

### Submits a batch domain name transfer-in task
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-batch-task-for-creating-order-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | User IP address, which can be set to 127.0.0.1 |
| Lang | string | no | Language of the error message returned by the API. Valid values: zh: Chinese. en: English. Default value is en |
| CouponNo | string | no | Coupon number |
| UseCoupon | string | no | Is a coupon used? Valid values: false: No. true: Yes |
| PromotionNo | string | no | Coupon number |
| UsePromotion | string | no | Whether to use a coupon. Valid values: false: Do not use. true: Use |
| OrderTransferParam | string | yes | List of job details (JSON-encoded) |

### Submits a batch task for domain name privacy protection
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-batch-task-for-domain-name-proxy-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the user |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| Status | string | yes | Specifies whether to enable or disable the privacy protection service. Valid values: true: Enabled. false: Disabled |
| DomainName | string | yes | The list of domain names. Separate multiple domain names with commas (,) (JSON-encoded) |
| ServiceType | string | no | The type of the privacy service instance |

### Submits a batch task to modify the DNS servers of domain names
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-batch-task-for-modifying-domain-dns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the client. You can set this parameter to 127.0.0.1 |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| AliyunDns | string | yes | Specifies whether to change the DNS servers to Alibaba Cloud DNS. Valid values: true: Yes. false: No |
| DomainName | string | yes | The domain names (JSON-encoded) |
| DomainNameServer | string | no | The list of DNS servers. This parameter is required when AliyunDns is set to false (JSON-encoded) |

### Submits a batch task to reserve dropped HiChina domain names
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-batch-task-for-reserve-drop-list-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ContactTemplateId | string | yes | The ID of the contact template |
| Domains | string | yes | The list of domain names (JSON-encoded) |

### Submits a batch transfer-out task based on an authorization code
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-batch-task-for-transfer-out-by-authorization-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TransferOutParamList | string | yes | The list of transfer-out parameters (JSON-encoded) |

### Submits a batch transfer prohibition lock task
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-batch-task-for-transfer-prohibition-lock` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The client IP address |
| Lang | string | no | The language of the error message that is returned if the request fails. Valid values: zh: Chinese en: English Default value: en |
| Status | string | yes | Specifies whether to enable or disable the transfer prohibition lock. Valid values: true: Enable the transfer prohibition lock. false:… |
| DomainName | string | yes | The domain names for which you want to enable or disable the transfer prohibition lock (JSON-encoded) |

### Submits a batch task to set the update prohibition lock
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-batch-task-for-update-prohibition-lock` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the user |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| Status | string | yes | Specifies whether to enable the update prohibition lock. Valid values: true: Enabled. false: Disabled |
| DomainName | string | yes | The list of domain names (JSON-encoded) |

### Submits a domain name information modification task with new contact information
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-batch-task-for-updating-contact-info-by-new-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Address | string | no | The detailed address |
| UserClientIp | string | no | The IP address of the user |
| Lang | string | no | The language of the error message returned by the operation. Valid values: zh: Chinese. en: English. Default value: en |
| City | string | no | The city |
| RegistrantOrganization | string | no | The name of the registrant |
| RegistrantName | string | no | The name of the contact |
| Province | string | no | The province |
| Country | string | no | The country code, such as CN and US |
| Email | string | no | The email address |
| PostalCode | string | no | The postal code |
| TelArea | string | no | The country code of the phone number |
| Telephone | string | no | The phone number |
| TelExt | string | no | The extension number |
| ZhCity | string | no | The city name in Chinese |
| ZhRegistrantOrganization | string | no | The registrant name in Chinese |
| ZhRegistrantName | string | no | The contact name in Chinese |
| ZhProvince | string | no | The province name in Chinese |
| ZhAddress | string | no | The address in Chinese |
| ContactType | string | yes | The contact type. Valid values: registrant: Domain name registrant. admin: Administrator. billing: Billing contact. tech: Technical contact |
| RegistrantType | string | yes | The registrant type. Valid values: 1: Individual. 2: Enterprise |
| TransferOutProhibited | string | no | Specifies whether to add a transfer prohibition lock. This parameter takes effect only when ContactType is set to registrant, and… |
| DomainName | string | yes | The list of domain names (JSON-encoded) |

### Submits a batch task to update domain name information by registrant profile ID
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-batch-task-for-updating-contact-info-by-registrant-prof` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| RegistrantProfileId | integer | yes | The ID of the domain name registrant profile. The ID is automatically generated by the system after the domain name registrant profile is… |
| ContactType | string | yes | The type of the contact to be updated. Valid values: registrant: Domain name registrant. admin: Administrator. billing: Billing contact.… |
| TransferOutProhibited | string | no | Specifies whether to add a transfer-out prohibition lock. This parameter is valid only when ContactType is set to registrant. It specifies… |
| DomainName | string | yes | The domain name. To specify multiple domain names, use a list (JSON-encoded) |

### Creates or updates a domain name group
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-domain-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | Language for error messages returned by the API. Valid values: zh: Chinese; en: English. Default value is en |
| UserClientIp | string | no | User IP address |
| DomainGroupName | string | yes | Domain Name Group Name |
| DomainGroupId | integer | no | Domain group ID. If this parameter is not provided, a new group is created. If it is provided, the domain group name is updated |

### Creates or updates a domain name registrant profile
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-registrant-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DefaultRegistrantProfile | string | no | Whether to set this profile as the default template. Valid values: true: Default template. false: Non-default template. Default value:… |
| Country | string | no | Country code. For example, CN represents China and US represents the United States |
| UserClientIp | string | no | User IP address. You can set it to 127.0.0.1 |
| Lang | string | no | Language of the error message returned by the API. Valid values: zh: Chinese. en: English. Default value: en. |
| RegistrantProfileId | integer | no | The information template ID, which is automatically generated by the system after the information template is successfully created. You… |
| City | string | no | City (English). Enter the name of the city where the registrant is located. Include the word “shi” (meaning “city”) in the city name. For… |
| RegistrantOrganization | string | no | Registrant name (in English) |
| RegistrantName | string | no | Contact name (in English) |
| Province | string | no | Province (in English). Enter the name of the province where the registrant resides. Enter only the province name without the word… |
| Address | string | no | Street address (English). |
| Email | string | no | Mailbox. |
| PostalCode | string | no | Postal code. |
| TelArea | string | no | Telephone country code. For example, the telephone country code for China is 86 |
| Telephone | string | no | Telephone number. |
| TelExt | string | no | Extension number |
| ZhRegistrantOrganization | string | no | Registrant name (in Chinese) |
| ZhRegistrantName | string | no | Contact name (Chinese). |
| ZhProvince | string | no | Province (Chinese). Enter the name of the province where the registrant is located. Enter only the province name without the word “省”. For… |
| ZhAddress | string | no | Detailed address (in Chinese) |
| ZhCity | string | no | City (in Chinese). Enter the name of the city where the registrant resides. Include the Chinese character "市" in the city name. For… |
| RegistrantType | string | no | Registrant type. Valid values: 1: Individual. 2: Organization. Default value: 1. |
| RegistrantProfileType | string | no | Information template type. Valid values: common: General template. cnnic: CNNIC template. The CNNIC template is supported only on the… |

### Saves the domain name contact and certificate information
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-registrant-profile-real-name-verification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Country | string | no | The country code, such as CN. This parameter is available and required only when the RegistrantProfileId parameter is not specified. If… |
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| RegistrantProfileId | integer | no | The ID of the registrant profile to be saved. The ID is automatically generated by the system after the registrant profile is created. You… |
| City | string | no | The city name in English. This parameter is available and required only when the RegistrantProfileId parameter is not specified. If this… |
| RegistrantOrganization | string | no | The name of the domain name registrant in English. This parameter is available and required only when the RegistrantProfileId parameter is… |
| RegistrantName | string | no | The name of the domain name contact in English. This parameter is available and required only when the RegistrantProfileId parameter is… |
| Province | string | no | The province name in English. This parameter is available and required only when the RegistrantProfileId parameter is not specified. If… |
| Address | string | no | The detailed address in English. This parameter is available and required only when the RegistrantProfileId parameter is not specified. If… |
| Email | string | no | The email address. This parameter is available and required only when the RegistrantProfileId parameter is not specified. If this… |
| PostalCode | string | no | The postal code. This parameter is available and required only when the RegistrantProfileId parameter is not specified. If this parameter… |
| TelArea | string | no | The country code for the phone number. For example, the country code for China is 86 |
| Telephone | string | no | The phone number. This parameter is available and required only when the RegistrantProfileId parameter is not specified. If this parameter… |
| TelExt | string | no | The extension number. This parameter is available and required only when the RegistrantProfileId parameter is not specified. If this… |
| ZhRegistrantOrganization | string | no | The name of the domain name registrant in Chinese. This parameter is applicable only to the Alibaba Cloud China site. This parameter is… |
| ZhRegistrantName | string | no | The name of the domain name contact in Chinese. This parameter is applicable only to the Alibaba Cloud China site. This parameter is… |
| ZhProvince | string | no | The province name in Chinese. This parameter is applicable only to the Alibaba Cloud China site. This parameter is available and required… |
| ZhAddress | string | no | The detailed address in Chinese. This parameter is applicable only to the Alibaba Cloud China site. This parameter is available and… |
| ZhCity | string | no | The city name in Chinese. This parameter is applicable only to the Alibaba Cloud China site. This parameter is available and required only… |
| RegistrantType | string | no | The type of the domain name registrant. Valid values: 1: Individual. 2: Enterprise or organization. This parameter is available and… |
| RegistrantProfileType | string | no | The template type of the registrant profile. Valid values: common: General template. cnnic: CNNIC template. The CNNIC template is… |
| IdentityCredential | string | no | The Base64-encoded image of the real-name verification material. The image must meet the following requirements: The image is in jpg or… |
| IdentityCredentialNo | string | no | The certificate number for real-name verification |
| IdentityCredentialType | string | no | The type of the certificate for real-name verification. Valid values: SFZ: ID card. HZ: Passport. YYZZ: Business license. ORG:… |

### Submits a task to create a DS record
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-adding-dsrecord` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | Domain name |
| Lang | string | no | Language of error messages returned by the API. Valid values: zh: Chinese; en: English. Default value: en |
| KeyTag | integer | yes | Key tag used to identify DNSSEC records. It is an integer less than 65536 |
| UserClientIp | string | no | User IP address, which can be set to 127.0.0.1 |
| Algorithm | integer | yes | The encryption algorithm number. For more information, see Domain Name System Security (DNSSEC) Algorithm Numbers… |
| DigestType | integer | yes | Summary algorithm type. For more information, see Delegation Signer (DS) Resource Record (RR) Type Digest Algorithms… |
| Digest | string | yes | Summary |

### Submits a task for a quick transfer-out of a domain name
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-apply-quick-transfer-out-openly` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The domain name |
| Lang | string | no | The language of the returned error message. Valid values: zh (Chinese) and en (English). The default is en |
| UserClientIp | string | no | The user's client IP |

### Submit a job to attach an ENS address
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-associating-ens` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | User IP address |
| DomainName | string | yes | Domain name |
| Lang | string | no | Language of the error message returned by the API. Valid values: zh: Chinese en: English Default value: en |
| Address | string | yes | ENS address |

### Submits a task to cancel a domain name transfer-in
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-canceling-transfer-in` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | Domain name |
| Lang | string | no | Language for the error message returned by the API. Valid values: zh: Chinese en: English Default value: en |
| UserClientIp | string | no | User IP address |

### Submits a task to cancel a domain name transfer-out
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-canceling-transfer-out` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | Domain name |
| Lang | string | no | Language for error messages returned by the API. Valid values: zh: Chinese en: English Default value: en |
| UserClientIp | string | no | User IP address |

### Submits a task to create a DNS host
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-creating-dns-host` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InstanceId | string | yes | Domain instance ID, which can be obtained by calling the https://help.aliyun.com/document_detail/67712.html API. |
| Lang | string | no | Language of the error message returned by the API. Valid values: zh: Chinese en: English Default value: en. |
| DnsName | string | yes | DNS name. |
| UserClientIp | string | no | User IP address, which can be set to 127.0.0.1. |
| Ip | string | yes | List of IP addresses. You can specify up to 13 IP addresses. When specifying multiple IP addresses, pass them as a list. (JSON-encoded) |

### Submits a domain name registration task
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-creating-order-activate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ZhRegistrantName | string | no | The name of the domain name contact in Chinese. This parameter is applicable only to the China site. This parameter is available and… |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| DomainName | string | yes | The domain name that you want to register. When you register a domain name, you must specify the registrant information. If you do not… |
| SubscriptionDuration | integer | no | The subscription duration. Unit: year. Default value: 1 year. Maximum value: 10 years |
| RegistrantProfileId | integer | no | The ID of the domain name registrant profile. The profile contains information such as the registrant name, contact name, phone number,… |
| EnableDomainProxy | string | no | Specifies whether to enable the domain name privacy protection service. Valid values: true: Enable. false: Do not enable. Default value:… |
| PermitPremiumActivation | string | no | Specifies whether to allow the registration of premium domain names. Valid values: false: Not allowed. true: Allowed. Default value: false |
| AliyunDns | string | no | Specifies whether to use Alibaba Cloud DNS servers. Valid values: true and false. Default value: true. If you set this parameter to true,… |
| Dns1 | string | no | The first custom DNS server. This parameter is available and required only when the AliyunDns parameter is set to false. Make sure that… |
| UserClientIp | string | no | The IP address of the client. You can set this parameter to 127.0.0.1 |
| ZhCity | string | no | The city name in Chinese. This parameter is applicable only to the China site. This parameter is available and required only when the… |
| ZhRegistrantOrganization | string | no | The name of the domain name registrant in Chinese. This parameter is applicable only to the China site. This parameter is available and… |
| Country | string | no | The country code, such as CN. This parameter is available and required only when the RegistrantProfileId parameter is not specified. If… |
| Dns2 | string | no | The second custom DNS server. This parameter is available and required only when the AliyunDns parameter is set to false. Make sure that… |
| ZhProvince | string | no | The province name in Chinese. This parameter is applicable only to the China site. This parameter is available and required only when the… |
| ZhAddress | string | no | The detailed address in Chinese. This parameter is applicable only to the China site. This parameter is available and required only when… |
| City | string | no | The city name in English. This parameter is available and required only when the RegistrantProfileId parameter is not specified. If you do… |
| RegistrantOrganization | string | no | The name of the domain name registrant in English. This parameter is available and required only when the RegistrantProfileId parameter is… |
| RegistrantName | string | no | The name of the domain name contact in English. This parameter is available and required only when the RegistrantProfileId parameter is… |
| Province | string | no | The province name in English. This parameter is available and required only when the RegistrantProfileId parameter is not specified. If… |
| Address | string | no | The detailed address in English. This parameter is available and required only when the RegistrantProfileId parameter is not specified. If… |
| Email | string | no | The email address. This parameter is available and required only when the RegistrantProfileId parameter is not specified. If you do not… |
| PostalCode | string | no | The postal code. This parameter is available and required only when the RegistrantProfileId parameter is not specified. If you do not… |
| TelArea | string | no | The country code for the phone number, such as 86 for China. This parameter is available and required only when the RegistrantProfileId… |
| Telephone | string | no | The phone number. This parameter is available and required only when the RegistrantProfileId parameter is not specified. If you do not… |
| TelExt | string | no | The extension number. This parameter is available and required only when the RegistrantProfileId parameter is not specified. If you do not… |
| RegistrantType | string | no | The type of the domain name registrant. Valid values: 1: Individual. 2: Enterprise or organization. This parameter is available and… |
| TrademarkDomainActivation | string | no | Specifies whether to allow the registration of trademark domain names. Valid values: false: Not allowed. true: Allowed |
| CouponNo | string | no | The ID of the voucher. Default value: a string |
| UseCoupon | string | no | Specifies whether to use a voucher. Valid values: true: Use. false: Do not use. Default value: false |
| PromotionNo | string | no | The ID of the coupon |
| UsePromotion | string | no | Specifies whether to use a coupon. Valid values: false: Not allowed. true: Allowed. Default value: false |
| ResourceGroupId | string | no | None |
| ExpectedPunycode | string | no | The domain name in Punycode format. This parameter can be left empty |

### Submits a domain name redemption task
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-creating-order-redeem` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | User IP address |
| Lang | string | no | Language of error messages returned by the API. Valid values: zh: Chinese. en: English. Default value: en |
| DomainName | string | yes | Domain name to be redeemed |
| CurrentExpirationDate | integer | yes | Current expiration time of the domain name, represented as the number of milliseconds since 00:00:00 UTC on January 1, 1970 |
| CouponNo | string | no | Coupon number |
| UseCoupon | string | no | Is a coupon used |
| PromotionNo | string | no | Coupon number |
| UsePromotion | string | no | Is a coupon used |

### Submits a domain name renewal task
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-creating-order-renew` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The user's IP address. You can set this parameter to 127.0.0.1 |
| Lang | string | no | The language of error messages returned by the API. Valid values: zh: Chinese. en: English. The default value is en |
| DomainName | string | yes | The domain name to renew |
| SubscriptionDuration | integer | yes | The renewal period, in years. The value must be an integer from 1 to 10 |
| CurrentExpirationDate | integer | yes | The current expiration date of the domain name. This value is a Unix timestamp in milliseconds, representing the time elapsed since… |
| CouponNo | string | no | The coupon number |
| UseCoupon | string | no | Specifies whether to use a coupon. Valid values: false: Do not use a coupon. true: Use a coupon |
| PromotionNo | string | no | The promotion number |
| UsePromotion | string | no | Specifies whether to use a promotion. Valid values: false: Do not use a promotion. true: Use a promotion |
| PermitPremiumRenew | string | no | The PermitPremiumRenew |

### Submits a domain name transfer-in task
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-creating-order-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | User IP address |
| Lang | string | no | Language for error messages returned by the API. Valid values: zh: Chinese; en: English. Default value: en |
| DomainName | string | yes | Domain name |
| AuthorizationCode | string | yes | Domain name transfer-in password |
| RegistrantProfileId | integer | yes | ID of the domain name registrant profile that has passed identity verification |
| PermitPremiumTransfer | string | no | Is transfer-in of premium domain names allowed. Default value: false |
| CouponNo | string | no | Coupon number |
| UseCoupon | string | no | Is a coupon used |
| PromotionNo | string | no | Coupon number |
| UsePromotion | string | no | Is a coupon used |

### Submits a task to delete a DS record
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-deleting-dsrecord` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | Domain name |
| Lang | string | no | Language of error messages returned by the API. Valid values: zh: Chinese en: English Default value: en |
| KeyTag | integer | yes | Key tag, used to identify DNSSEC records. It is an integer value less than 65536 |
| UserClientIp | string | no | User IP address |

### Submits a task to delete a DNS host
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-deleting-dns-host` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InstanceId | string | yes | Instance ID |
| Lang | string | no | Language of error messages returned by the API. Valid values: zh: Chinese en: English Default value: en |
| DnsName | string | yes | DNS name |
| UserClientIp | string | no | User IP address |

### Submits a task to disassociate an ENS address
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-disassociating-ens` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | User IP address. |
| DomainName | string | yes | Domain name. |
| Lang | string | no | Language of the error message returned by the API. Valid values: zh: Chinese en: English Default value: en. |

### Submits a domain name privacy protection service task
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-domain-name-proxy-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |
| Lang | string | no | The language of the error message returned by the API. Valid values: zh: Chinese. en: English. Default value: en |
| DomainName | string | yes | The domain name |
| Status | string | yes | Specifies whether to enable the service. Valid values: true: Enabled. false: Disabled |

### Submits a task to modify a DS record
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-modifying-dsrecord` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | Domain name. |
| Lang | string | no | Language of error messages returned by the API. Valid values: zh: Chinese en: English Default value: en. |
| KeyTag | integer | yes | Key tag used to identify DNSSEC records. It is an integer less than 65536. |
| UserClientIp | string | no | User IP address. |
| Algorithm | integer | yes | Encryption algorithm number. For more information, see Domain Name System Security (DNSSEC) Algorithm Numbers… |
| DigestType | integer | yes | Digest algorithm type. For more information, see Delegation Signer (DS) Resource Record (RR) Type Digest Algorithms… |
| Digest | string | yes | Summary value. |

### Submits a task to modify a DNS host
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-modifying-dns-host` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InstanceId | string | yes | Domain instance ID, which can be obtained by invoking the QueryDomainList API. |
| Lang | string | no | Language for error messages returned by the API. Valid values: zh: Chinese. en: English. Default value: en |
| DnsName | string | yes | DNS name |
| UserClientIp | string | no | User IP address |
| Ip | string | yes | List of IP addresses (JSON-encoded) |

### Submits a task to obtain the transfer password of a domain name
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-querying-transfer-authorization-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | Domain name. |
| Lang | string | no | Language for error messages returned by the API. Valid values: zh: Chinese en: English Default value: en. |
| UserClientIp | string | no | User IP address. |

### Submits a task to create Art extension information
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-save-art-extension` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | Domain name |
| ObjectType | string | no | Artwork category |
| MaterialsAndTechniques | string | no | Materials and techniques |
| Dimensions | string | no | Dimensions |
| Title | string | no | Name |
| DateOrPeriod | string | no | Creation time |
| Maker | string | no | Artist or creator |
| InscriptionsAndMarkings | string | no | Inscriptions and markings |
| Subject | string | no | Art subject |
| Features | string | no | Artistic features |
| Reference | string | no | Reference |
| Lang | string | no | Language of the error message returned by the API. Valid values: zh: Chinese en: English Default value: en |

### Submits a task to synchronize a DS record
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-synchronizing-dsrecord` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | Domain name |
| Lang | string | no | Language of error messages returned by the API. Valid values: zh: Chinese en: English Default value: en |
| UserClientIp | string | no | User IP address |

### Submits a task to synchronize a DNS host. This operation is used to handle cases such as missing or…
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-synchronizing-dns-host` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InstanceId | string | yes | Domain instance ID, which can be obtained by invoking the https://help.aliyun.com/document_detail/67712.html API |
| Lang | string | no | Language for error messages returned by the API. Valid values: zh: Chinese en: English Default value: en |
| UserClientIp | string | no | User IP address |

### Submits a single transfer-out task based on an authorization code
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-transfer-out-by-authorization-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomainName | string | yes | The domain name |
| AuthorizationCode | string | yes | The authorization code |

### Submits a transfer prohibition lock task
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-transfer-prohibition-lock` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | User IP address |
| Lang | string | no | Language of error messages returned by the API. Valid values: zh: Chinese; en: English. Default value: en |
| DomainName | string | yes | Domain name |
| Status | string | yes | Enabled or shutdown status. Valid values: true: Enabled; false: Shutdown |

### Submits an update prohibition lock task
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-update-prohibition-lock` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | User IP address |
| Lang | string | no | Language of the error message returned by the API. Valid values: zh: Chinese; en: English. Default value: en |
| DomainName | string | yes | Domain name |
| Status | string | yes | Enabled or shutdown status. Valid values: true: Enabled; false: Shutdown |

### Submits a task to update domain name contact information
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-single-task-for-updating-contact-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | User IP address |
| Lang | string | no | Language of error messages returned by the API. Valid values: zh: Chinese en: English Default value: en |
| DomainName | string | yes | Domain name |
| InstanceId | string | no | Domain instance ID |
| RegistrantProfileId | integer | yes | Information template ID |
| ContactType | string | yes | Contact type. Valid values: registrant admin billing tech |
| AddTransferLock | string | no | Specifies whether to add a transfer-out restriction. This parameter takes effect only when ContactType is registrant. It indicates whether… |

### Submit a domain deletion job. Only whitelist users can access this API
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-task-for-submitting-domain-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the error message returned by the API. Valid values: zh: Chinese. en: English. Default value: en |
| UserClientIp | string | no | The user IP address |
| InstanceId | string | yes | The instance ID |

### Submits a domain name real-name verification task
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-task-for-submitting-domain-real-name-verification-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the user |
| Lang | string | no | The language of the error message returned by the operation. Valid values: zh: Chinese. en: English. Default value: en |
| IdentityCredential | string | yes | The Base64-encoded image of the real-name verification material. The image must meet the following requirements: The image is in JPG or… |
| IdentityCredentialNo | string | yes | The certificate number of the real-name verification material, such as the ID card number or Unified Social Credit Code |
| IdentityCredentialType | string | yes | The type of the certificate used for real-name verification. Valid values: SFZ: ID card. HZ: Passport. YYZZ: Business license. ORG:… |
| DomainName | string | yes | The list of domain names (JSON-encoded) |

### Creates a task to submit real-name verification information for a domain name by using a specified…
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-task-for-submitting-domain-real-name-verification-by-re` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the client that makes the request |
| Lang | string | no | The language of the error message to return. Valid values: `zh` (Chinese) and `en` (English). Default value: `en` |
| DomainName | string | yes | The domain name to submit for real-name verification |
| InstanceId | string | yes | The ID of the domain name instance |
| RegistrantProfileId | integer | yes | The ID of the registrant profile to use for real-name verification |

### Submits a batch task to update registrant information by using identity credentials and required materials
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-task-for-updating-registrant-info-by-identity-credentia` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PostalCode | string | no | The postal code |
| Address | string | no | The detailed address |
| UserClientIp | string | no | The IP address of the user |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| City | string | no | The city |
| RegistrantOrganization | string | no | The name of the organization registrant |
| RegistrantName | string | no | The name of the registrant |
| Province | string | no | The province |
| Email | string | no | The email address |
| Country | string | no | The country code, such as CN or US |
| TelArea | string | yes | The country code for the phone number |
| Telephone | string | yes | The phone number |
| TelExt | string | no | The extension number |
| ZhCity | string | no | The city name in Chinese |
| ZhRegistrantOrganization | string | no | The name of the organization registrant in Chinese |
| ZhRegistrantName | string | no | The name of the registrant in Chinese |
| ZhProvince | string | no | The province name in Chinese |
| ZhAddress | string | no | The address in Chinese |
| RegistrantType | string | yes | The type of the domain name registrant. Valid values: 1: Individual. 2: Enterprise |
| IdentityCredentialType | string | yes | The type of the identity certificate used for real-name verification. Valid values: SFZ: ID card. HZ: Passport. YYZZ: Business license.… |
| IdentityCredentialNo | string | yes | The number of the identity certificate used for real-name verification, such as the ID card number or Unified Social Credit Code |
| IdentityCredential | string | yes | The Base64-encoded image of the identity certificate used for real-name verification. The image must meet the following requirements: The… |
| TransferOutProhibited | string | yes | Specifies whether to add a transfer-out prohibition lock, which restricts the domain name from being transferred out within 60 days after… |
| DomainName | string | yes | The list of domain names (JSON-encoded) |

### Submits a task to modify registrant contact information by using a domain name registrant profile ID
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/save-task-for-updating-registrant-info-by-registrant-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| RegistrantProfileId | integer | yes | The ID of the domain name registrant profile. You can call the QueryRegistrantProfiles… |
| TransferOutProhibited | string | yes | Specifies whether to add a transfer prohibition lock, which restricts the domain name from being transferred out within 60 days after the… |
| DomainName | string | yes | The list of domain names. If multiple domain names are specified, pass them in a list. You can call the QueryDomainList… |

### Scrolls through the domain name list
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/scroll-domain-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| EndExpirationDate | integer | no | The end time of the domain name expiration date range to query. The value is the number of milliseconds that have elapsed since 00:00:00… |
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |
| Lang | string | no | The language of the error message returned by the API. Valid values: zh: Chinese. en: English. Default value: en |
| StartExpirationDate | integer | no | The start time of the domain name expiration date range to query. The value is the number of milliseconds that have elapsed since 00:00:00… |
| ProductDomainType | string | no | The type of the domain name. Valid values: New gTLD gTLD ccTLD other |
| PageSize | integer | no | The number of entries per page for the domain name list |
| DomainGroupId | integer | no | The ID of the domain name group. You can call the QueryDomainGroupList (https://help.aliyun.com/document_detail/69362.html) operation to… |
| DomainStatus | integer | no | The status of the domain name. Valid values: 0: All 1: Urgent renewal required 2: Urgent redemption required 3: Normal 4: Being… |
| EndLength | integer | no | The maximum length of the domain names to query |
| Excluded | string | no | The excluded keyword |
| ExcludedPrefix | string | no | The excluded prefix keyword |
| ExcludedSuffix | string | no | The excluded suffix keyword |
| Form | integer | no | The domain name composition |
| KeyWord | string | no | The keyword |
| KeyWordPrefix | string | no | The prefix keyword |
| KeyWordSuffix | string | no | The suffix keyword |
| StartLength | integer | no | The minimum length of the domain names to query |
| TradeType | integer | no | The publishing status. Valid values: 2: Fixed price published 3: Online negotiation published 4: Auction published 6: Domain push with… |
| Suffixs | string | no | The list of suffixes to query. Separate multiple suffixes with commas (,) |
| StartRegistrationDate | integer | no | The start time of the domain name registration date range to query. The value is the number of milliseconds that have elapsed since… |
| EndRegistrationDate | integer | no | The end time of the domain name registration date range to query. The value is the number of milliseconds that have elapsed since 00:00:00… |
| ScrollId | string | no | The scroll ID for pagination |
| ResourceGroupId | string | no | The ID of the resource group |

### Sets the default domain name registrant profile
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/set-default-registrant-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserClientIp | string | no | The user IP address. Default value: 127.0.0.1 |
| RegistrantProfileId | integer | yes | The ID of the registrant profile to be set as the default. The ID is automatically generated by the system after the registrant profile is… |

### Sets or cancels auto-renewal for a domain name
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/setup-domain-auto-renew` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Operation | string | yes | The operation type |
| InstanceId | string | yes | The instance ID of the domain name |

### 域名特殊业务提交资料
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/submit-domain-special-biz-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| BizId | integer | no | The BizId |
| Credentials | string | no | The Credentials |
| Extend | string | no | The Extend |
| UserClientIp | string | no | The UserClientIp |

### Sends an email to authenticate the mailbox
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/submit-email-verification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the error message returned by the operation. Valid values: zh: Chinese. en: English. Default value: en |
| Email | string | yes | The email addresses that require verification. Separate multiple email addresses with commas (,) |
| SendIfExist | string | no | Specifies whether to resend the verification email if a verification email already exists. Valid values: true: Resend the verification… |
| UserClientIp | string | no | The IP address of the user. You can set this parameter to 127.0.0.1 |

### Submits self-service business audit information
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/submit-operation-audit-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| DomainName | string | yes | The domain name. You can specify one or more domain names. Separate multiple domain names with commas (,) |
| AuditType | integer | yes | The business type. Valid values: 1: Offline domain name transfer. This transfers a domain name from the current Alibaba Cloud account to… |
| AuditInfo | string | no | The information to be audited. The displayed information varies based on the business type |
| Id | integer | no | The audit ID |

### Submits the certificate materials pending review for self-service operations
`POST https://www.apizie.tech/v1/cloud:aliyun-domain/submit-operation-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the error message returned by the API operation. Valid values: zh: Chinese. en: English. Default value: en |
| AuditRecordId | integer | no | The ID of the audit record |
| RegType | integer | no | The type of the domain name registrant. Valid values: 1: Individual. 2: Enterprise |
| AuditType | integer | no | The audit type. Valid values: 1: Offline domain name transfer |
| Credentials | string | no | The information about the certificate materials pending review |

…and 8 more. See the OpenAPI spec.

## Example
```
curl "https://www.apizie.tech/v1/cloud:aliyun-domain/acknowledge-task-result" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Domain API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:aliyun-domain/acknowledge-task-result with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Domain API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Domain itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Domain API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-domain.

### What is the status of the Alibaba Cloud Domain API?
Needs your own provider key (bring your own key)