API概览

本产品(域名服务/2018-01-29)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

域名注册、续费和赎回

API标题API概述
SaveSingleTaskForCreatingOrderActivate提交域名注册任务调用SaveSingleTaskForCreatingOrderActivate提交域名注册任务。
SaveBatchTaskForCreatingOrderActivate提交批量注册域名任务调用SaveBatchTaskForCreatingOrderActivate提交批量注册域名的任务。
SaveBatchTaskForCreatingOrderRenew提交批量域名续费任务调用SaveBatchTaskForCreatingOrderRenew提交批量域名续费任务。
SaveSingleTaskForCreatingOrderRenew提交域名续费任务调用SaveSingleTaskForCreatingOrderRenew提交域名续费任务。
SaveSingleTaskForCreatingOrderRedeem提交域名赎回任务调用SaveSingleTaskForCreatingOrderRedeem提交域名赎回任务。
SaveBatchTaskForCreatingOrderRedeem提交批量域名赎回任务调用SaveBatchTaskForCreatingOrderRedeem提交批量域名赎回任务。
CheckDomain检查域名是否可以注册调用CheckDomain检查域名是否可以注册。
FuzzyMatchDomainSensitiveWord检查域名是否包含敏感词调用FuzzyMatchDomainSensitiveWord检查域名是否包含敏感词。
BatchFuzzyMatchDomainSensitiveWord批量检查域名是否包含敏感词调用BatchFuzzyMatchDomainSensitiveWord批量检查域名是否包含敏感词。

实名认证

API标题API概述
模板管理模板管理
SaveRegistrantProfile创建或更新域名信息模板调用SaveRegistrantProfile接口创建或更新域名信息模板。
DeleteRegistrantProfile删除指定的域名信息模板调用DeleteRegistrantProfile接口删除指定的域名信息模板。
DeleteContactTemplates删除联系人模版批量删除域名联系人模板。
RegistrantProfileRealNameVerification提交信息模板实名认证调用RegistrantProfileRealNameVerification接口提交信息模板实名认证。
SetDefaultRegistrantProfile设置默认联系人信息调用SetDefaultRegistrantProfile接口设置域名联系人默认模板。
QueryDomainAdminDivision查询中国行政区划调用QueryDomainAdminDivision查询中国行政区划。
QueryFailReasonForRegistrantProfileRealNameVerification查询信息模板实名认证审核失败的原因调用QueryFailReasonForRegistrantProfileRealNameVerification接口查询信息模板实名认证审核失败的原因。
VerifyContactField校验域名联系人信息部分参数是否必传将根据注册局要求而定。
QueryRegistrantProfiles查询当前账号下的域名信息模板调用QueryRegistrantProfiles接口查询当前账号下的域名信息模板。
QueryRegistrantProfileRealNameVerificationInfo查询信息模板实名认证资料调用QueryRegistrantProfileRealNameVerificationInfo接口查询信息模板实名认证资料。
SaveTaskForSubmittingDomainRealNameVerificationByIdentityCredential提交域名实名认证任务调用SaveTaskForSubmittingDomainRealNameVerificationByIdentityCredential提交域名实名认证任务。
SaveTaskForSubmittingDomainRealNameVerificationByRegistrantProfileID通过信息模板ID提交域名实名认证任务调用SaveTaskForSubmittingDomainRealNameVerificationByRegistrantProfileID通过信息模板ID提交域名实名认证任务。
CancelDomainVerification取消域名实名认证审核调用CancelDomainVerification取消域名实名认证审核。
QueryDomainRealNameVerificationInfo查询域名实名认证资料调用QueryDomainRealNameVerificationInfo查询域名实名认证资料。
QueryFailReasonForDomainRealNameVerification查询域名实名认证失败原因查询域名实名认证(包括命名审核)失败原因。

邮箱验证

API标题API概述
DeleteEmailVerification删除已经验证通过的邮箱调用DeleteEmailVerification接口删除已经验证通过的邮箱。
VerifyEmail提交邮箱验证调用VerifyEmail接口提交邮箱验证。
ResendEmailVerification重新发送验证邮件调用ResendEmailVerification接口重新发送验证邮件。
SubmitEmailVerification发送邮箱验证邮件调用SubmitEmailVerification接口发送邮箱验证邮件。
QueryEmailVerification查询邮箱验证结果调用QueryEmailVerification查询邮箱验证结果。
ListEmailVerification查询邮箱验证列表调用ListEmailVerification接口查询邮箱验证列表。

域名过户和信息修改

API标题API概述
SaveSingleTaskForUpdateProhibitionLock提交禁止更新锁任务调用SaveSingleTaskForUpdateProhibitionLock提交禁止更新锁任务。
SaveBatchTaskForUpdateProhibitionLock提交批量禁止更新锁任务调用SaveBatchTaskForUpdateProhibitionLock提交批量禁止更新锁任务。
SaveTaskForUpdatingRegistrantInfoByRegistrantProfileID提交修改注册联系人信息任务通过信息模板编号提交修改注册联系人信息任务。
SaveTaskForUpdatingRegistrantInfoByIdentityCredential提交批量修改注册联系人信息任务调用SaveTaskForUpdatingRegistrantInfoByIdentityCredential提交批量通过联系人信息和资料修改注册联系人信息任务,同时要求必须填写相应资料。
SaveSingleTaskForUpdatingContactInfo提交域名信息修改任务调用SaveSingleTaskForUpdatingContactInfo提交域名信息修改任务。
SaveBatchTaskForUpdatingContactInfoByNewContact提交域名信息修改任务通过新联系人信息,提交域名信息修改任务。
SaveBatchTaskForUpdatingContactInfoByRegistrantProfileId提交批量域名信息修改任务调用SaveBatchTaskForUpdatingContactInfoByRegistrantProfileId提交批量域名信息修改任务。

域名转移管理

API标题API概述
SaveBatchTaskForCreatingOrderTransfer提交批量域名转入任务调用SaveBatchTaskForCreatingOrderTransfer提交批量域名转入任务。
SaveSingleTaskForCreatingOrderTransfer提交域名转入任务调用SaveSingleTaskForCreatingOrderTransfer提交域名转入任务。
SaveSingleTaskForCancelingTransferIn提交取消域名转入任务调用SaveSingleTaskForCancelingTransferIn提交取消域名转入任务。
SaveSingleTaskForCancelingTransferOut提交取消域名转出任务调用SaveSingleTaskForCancelingTransferOut提交取消域名转出任务。
TransferInReenterTransferAuthorizationCode域名转入重新输入转移密码调用TransferInReenterTransferAuthorizationCode域名转入重新输入转移密码。
TransferInResendMailToken域名转入重新发送验证邮件调用TransferInResendMailToken域名转入重新发送验证邮件。
TransferInRefetchWhoisEmail进行域名转入邮箱验证调用TransferInRefetchWhoisEmail进行域名转入邮箱验证。
TransferInCheckMailToken域名转入验证邮件调用TransferInCheckMailToken验证域名持有者邮件Token。
SaveSingleTaskForQueryingTransferAuthorizationCode提交获取域名转移密码任务调用SaveSingleTaskForQueryingTransferAuthorizationCode提交获取域名转移密码任务。
SaveBatchTaskForTransferProhibitionLock提交批量禁止转移锁任务调用SaveBatchTaskForTransferProhibitionLock提交批量禁止转移锁任务。
SaveSingleTaskForApprovingTransferOut提交确认域名转出任务
SaveSingleTaskForTransferProhibitionLock提交禁止转移锁任务调用SaveSingleTaskForTransferProhibitionLock提交禁止转移锁任务。
ConfirmTransferInEmail确认转入邮箱
QueryTransferInByInstanceId根据实例编号查询域名转入信息调用QueryTransferInByInstanceId根据实例编号查询域名转入信息。
QueryTransferInList查询域名转入列表调用QueryTransferInList查询域名转入列表。
QueryTransferOutInfo查询域名转出信息调用QueryTransferOutInfo查询域名转出信息。
CheckTransferInFeasibility校验域名是否可以转入调用CheckTransferInFeasibility校验域名是否可以转入。

任务管理

API标题API概述
CancelTask取消进行中的任务调用CancelTask取消进行中的任务。
AcknowledgeTaskResult确认任务详情结果调用AcknowledgeTaskResult确认任务详情结果。
QueryTaskDetailHistory分页查询指定域名任务的详情历史列表调用QueryTaskDetailHistory分页查询指定域名任务的详情历史列表。
PollTaskResult获取执行完成任务详情调用PollTaskResult获取已经执行完成(包含执行成功和执行失败并超过重试次数)的域名任务详情列表。
QueryTaskList分页查询自己账号下的域名任务列表调用QueryTaskList分页查询自己账号下的域名任务列表。
QueryTaskInfoHistory分页查询自己账户下的域名任务历史列表调用QueryTaskInfoHistory分页查询自己账户下的域名任务历史列表。
QueryTaskDetailList分页查询指定域名任务的详情列表调用QueryTaskDetailList分页查询指定域名任务的详情列表。

域名信息查询

API标题API概述
QueryDomainByDomainName根据域名名称查询域名信息调用QueryDomainByDomainName按域名查询域名信息。
QueryContactInfo查询域名联系人信息调用QueryContactInfo查询域名联系人信息。
QueryDomainByInstanceId根据域名实例编号查询域名信息调用QueryDomainByInstanceId根据域名实例编号查询域名的基本信息。
QueryDomainList分页查询自己账户下的域名列表调用QueryDomainList分页查询自己账户下的域名列表。
ScrollDomainList翻页遍历域名列表调用ScrollDomainList翻页遍历域名列表。
QueryDomainSuffix查询高级搜索后缀列表调用QueryDomainSuffix高级搜索后缀列表。
QueryAdvancedDomainList高级搜索域名列表调用QueryAdvancedDomainList高级搜索域名列表。
LookupTmchNotice查询tmch(商标词)信息调用LookupTmchNotice根据传入商标词key查询tmch(商标词)信息。
CheckDomainSunriseClaim根据传入域名查询商标词 Key根据传入域名查询商标词key。
QueryArtExtension查询Art扩展信息调用QueryArtExtension查询Art扩展信息。

DNS管理

API标题API概述
SaveSingleTaskForCreatingDnsHost提交单个创建dnshost任务调用SaveSingleTaskForCreatingDnsHost提交单个创建dnshost任务。
SaveSingleTaskForAddingDSRecord提交创建DS记录任务调用SaveSingleTaskForAddingDSRecord提交创建DS记录任务。
SaveSingleTaskForDeletingDnsHost提交删除DNSHost任务调用SaveSingleTaskForDeletingDnsHost提交删除DNSHost任务。
SaveSingleTaskForDeletingDSRecord提交删除DS记录任务调用SaveSingleTaskForDeletingDSRecord提交删除DS记录任务。
SaveSingleTaskForSynchronizingDnsHost提交同步DNS host任务调用SaveSingleTaskForSynchronizingDnsHost提交同步DNS host任务。用来处理DNS host缺失、不一致等情况。
SaveSingleTaskForSynchronizingDSRecord提交同步DS记录任务调用SaveSingleTaskForSynchronizingDSRecord提交同步DS记录任务。
SaveSingleTaskForModifyingDnsHost提交修改dnshost任务调用SaveSingleTaskForModifyingDnsHost提交修改dnshost任务。
SaveSingleTaskForModifyingDSRecord提交修改DS记录任务调用SaveSingleTaskForModifyingDSRecord提交修改DS记录任务。
SaveBatchTaskForModifyingDomainDns提交批量修改域名DNS任务调用SaveBatchTaskForModifyingDomainDns提交批量修改域名DNS任务。
QueryDnsHost查询域名DNS Host调用QueryDnsHost查询域名DNS host。
QueryDSRecord查询域名DS记录调用QueryDSRecord查询域名DS记录。

分组管理

API标题API概述
DeleteDomainGroup删除域名分组删除超过1000个域名的分组为异步过程,需要等待系统处理。
UpdateDomainToDomainGroup向分组中设置域名如使用文件上传,替换超过1000个域名的分组,则该操作属于异步操作,需等待系统处理后才能看到结果。
SaveDomainGroup保存域名分组调用SaveDomainGroup创建、更新域名分组。
QueryDomainGroupList查询域名分组列表调用QueryDomainGroupList查询域名分组列表。

注册局锁管理

API标题API概述
QueryServerLock查询注册局锁详情查询域名在注册局的锁详情。
CheckProcessingServerLockApply检查是否有处理中的注册局锁申请记录检查域名在注册局,是否存在锁服务申请为“处理中”的状态。
CheckMaxYearOfServerLock检查域名注册局锁最大可购买或续费的年限检测域名最大可购买年限。
ListServerLock查询注册局锁列表信息查询域名在注册局的锁列表信息。

其他接口

API标题API概述
隐私保护隐私保护
SaveBatchTaskForDomainNameProxyService提交批量域名隐私保护服务任务调用SaveBatchTaskForDomainNameProxyService提交批量域名隐私保护服务任务。
SaveSingleTaskForDomainNameProxyService提交域名隐私保护服务任务调用SaveSingleTaskForDomainNameProxyService提交域名隐私保护服务任务。
.餐厅/.商标等资质管理.餐厅/.商标等资质管理
SubmitOperationAuditInfo提交线下审核任务调用SubmitOperationAuditInfo提交自助业务审核信息。
SubmitOperationCredentials提交自助业务待审核的证件资料调用SubmitOperationCredentials提交自助业务待审核的证件资料。
CancelOperationAudit取消线下审核申请调用CancelOperationAudit取消自助业务审核。
CancelQualificationVerification取消资质审核取消“.餐厅”、“.商标”域名资质审核。
ResetQualificationVerification重置资质审核状态.餐厅、.商标域名重置资质审核状态。
SaveRegistrantProfileRealNameVerification保存域名信息实名验证调用SaveRegistrantProfileRealNameVerification接口保存域名联系人和证件信息。
QueryFailingReasonListForQualification查询资质审核失败原因查询“.餐厅”、“.商标”域名资质审核失败原因。
QueryOperationAuditInfoDetail查询线下审核任务详情调用QueryOperationAuditInfoDetail查询自助业务的审核记录详情。
QueryOperationAuditInfoList查询线下审核任务列表调用QueryOperationAuditInfoList查询自助业务的审核记录列表。
QueryQualificationDetail查询资质审核详情查询“.餐厅”、“.商标”域名资质审核详情。
GetOperationOssUploadPolicy获取线下审核OSS上传策略调用GetOperationOssUploadPolicy获取审核资料的存储信息。
SaveTaskForSubmittingDomainDelete提交域名删除任务提交删除域名任务,仅白名单用户可以访问。
SaveSingleTaskForAssociatingEns提交绑定Ens地址任务提交绑定Ens地址任务。
SaveSingleTaskForDisassociatingEns提交解绑Ens地址任务调用SaveSingleTaskForDisassociatingEns提交解绑Ens地址任务。
SaveBatchDomainRemark批量保存域名备注调用SaveBatchDomainRemark批量保存域名备注。
SaveSingleTaskForSaveArtExtension提交创建Art扩展信息任务调用SaveSingleTaskForSaveArtExtension提交创建Art扩展信息任务。
QueryChangeLogList查询操作日志列表调用QueryChangeLogList分页查询您当前阿里云账号下的操作日志。
QueryLocalEnsAssociation查询本地Ens绑定地址调用QueryLocalEnsAssociation查询阿里云系统中记录的ens绑定地址。
QueryEnsAssociation查询Ens系统中绑定的钱包地址调用QueryEnsAssociation查询Ens系统中绑定的钱包地址。
GetQualificationUploadPolicy根据 SaleID 获取对应的授权策略获取“.餐厅”、“.商标”域名对应的授权策略。

其他

API标题API概述
ChangeResourceGroup修改域名所属资源组修改域名所属的资源组。
阿里云首页 域名 相关技术圈