API标准及多语言预置SDK
本产品（Domain/2018-01-29）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
域名注册、续费和赎回
|
API |
标题 |
API概述 |
| SaveSingleTaskForCreatingOrderActivate | 提交域名注册任务 | 提交域名注册任务。 |
| SaveBatchTaskForCreatingOrderActivate | 提交批量注册域名任务 | 提交批量注册域名的任务。 |
| SaveBatchTaskForCreatingOrderRenew | 提交批量域名续费任务 | 提交批量域名续费任务。 |
| SaveSingleTaskForCreatingOrderRenew | 提交域名续费任务 | 调用SaveSingleTaskForCreatingOrderRenew提交域名续费任务。 |
| SaveSingleTaskForCreatingOrderRedeem | 提交域名赎回任务 | 调用SaveSingleTaskForCreatingOrderRedeem提交域名赎回任务。 |
| SaveBatchTaskForCreatingOrderRedeem | 提交批量域名赎回任务 | 调用SaveBatchTaskForCreatingOrderRedeem提交批量域名赎回任务。 |
| CheckDomain | 检查域名是否可以注册 | 调用CheckDomain检查域名是否可以注册。 |
| FuzzyMatchDomainSensitiveWord | 检查域名是否包含敏感词 | 调用FuzzyMatchDomainSensitiveWord检查域名是否包含敏感词。 |
| BatchFuzzyMatchDomainSensitiveWord | 批量检查域名是否包含敏感词 | 调用BatchFuzzyMatchDomainSensitiveWord批量检查域名是否包含敏感词。 |
| SetupDomainAutoRenew | 设置或取消域名自动续费 | 您可以调用该接口设置或取消域名自动续费。 |
模板管理
|
API |
标题 |
API概述 |
| SaveRegistrantProfile | 创建或更新域名信息模板 | 调用SaveRegistrantProfile接口创建或更新域名信息模板。 |
| DeleteRegistrantProfile | 删除指定的域名信息模板 | 调用DeleteRegistrantProfile接口删除指定的域名信息模板。 |
| DeleteContactTemplates | 删除联系人模板 | 批量删除域名联系人模板。 |
| RegistrantProfileRealNameVerification | 提交信息模板实名认证 | 调用RegistrantProfileRealNameVerification接口提交信息模板实名认证。 |
| SetDefaultRegistrantProfile | 设置默认联系人信息 | 调用SetDefaultRegistrantProfile接口设置域名联系人默认模板。 |
| QueryDomainAdminDivision | 查询中国行政区划 | 调用QueryDomainAdminDivision查询中国行政区划。 |
| QueryFailReasonForRegistrantProfileRealNameVerification | 查询信息模板实名认证审核失败的原因 | 调用QueryFailReasonForRegistrantProfileRealNameVerification接口查询信息模板实名认证审核失败的原因。 |
| VerifyContactField | 校验域名联系人信息 | 部分参数是否必传将根据注册局要求而定。该API是对输入参数合规，合法性进行校验，并不与域名信息进行对比校验。 |
| QueryRegistrantProfiles | 查询当前账号下的域名信息模板 | 调用QueryRegistrantProfiles接口查询当前账号下的域名信息模板。 |
| QueryRegistrantProfileRealNameVerificationInfo | 查询信息模板实名认证资料 | 调用QueryRegistrantProfileRealNameVerificationInfo接口查询信息模板实名认证资料。 |
实名认证
|
API |
标题 |
API概述 |
| 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域名转入重新输入转移密码。 |
| SaveSingleTaskForQueryingTransferAuthorizationCode | 提交获取域名转移密码任务 | 调用SaveSingleTaskForQueryingTransferAuthorizationCode提交获取域名转移密码任务。 |
| SaveBatchTaskForTransferProhibitionLock | 提交批量禁止转移锁任务 | 调用SaveBatchTaskForTransferProhibitionLock提交批量禁止转移锁任务。 |
| SaveSingleTaskForTransferProhibitionLock | 提交禁止转移锁任务 | 调用SaveSingleTaskForTransferProhibitionLock提交禁止转移锁任务。 |
| ConfirmTransferInEmail | 确认转入邮箱 | 调用ConfirmTransferInEmail确认转入邮箱。 |
| QueryTransferInByInstanceId | 根据实例编号查询域名转入信息 | 调用QueryTransferInByInstanceId根据实例编号查询域名转入信息。 |
| QueryTransferInList | 查询域名转入列表 | 调用QueryTransferInList查询域名转入列表。 |
| QueryTransferOutInfo | 查询域名转出信息 | 调用QueryTransferOutInfo查询域名转出信息。 |
| CheckTransferInFeasibility | 校验域名是否可以转入 | 调用CheckTransferInFeasibility校验域名是否可以转入。 |
| SaveSingleTaskForApplyQuickTransferOutOpenly | 提交快速转出域名申请任务 | 提交快速转出域名申请任务。 |
| SaveBatchTaskForApplyQuickTransferOutOpenly | 提交批量快速转出域名申请任务 | 提交批量快速转出域名申请任务。 |
任务管理
|
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 | 分页查询自己账户下的域名列表 | 分页查询自己账户下的域名列表。 |
| 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概述 |
| SubmitOperationAuditInfo | 提交线下审核任务 | 调用SubmitOperationAuditInfo提交自助业务审核信息。 |
| SubmitOperationCredentials | 提交自助业务待审核的证件资料 | 调用SubmitOperationCredentials提交自助业务待审核的证件资料。 |
| CancelOperationAudit | 取消线下审核申请 | 调用CancelOperationAudit取消自助业务审核。 |
| CancelQualificationVerification | 取消资质审核 | 取消“.餐厅”、“.商标”域名资质审核。 |
| ResetQualificationVerification | 重置资质审核状态 | .餐厅、.商标域名重置资质审核状态。 |
| SaveRegistrantProfileRealNameVerification | 保存域名信息实名验证 | 调用SaveRegistrantProfileRealNameVerification接口保存域名联系人和证件信息。 |
| QueryFailingReasonListForQualification | 查询资质审核失败原因 | 查询“.餐厅”、“.商标”域名资质审核失败原因。 |
| QueryOperationAuditInfoDetail | 查询线下审核任务详情 | 调用QueryOperationAuditInfoDetail查询自助业务的审核记录详情。 |
| QueryOperationAuditInfoList | 查询线下审核任务列表 | 调用QueryOperationAuditInfoList查询自助业务的审核记录列表。 |
| QueryQualificationDetail | 查询资质审核详情 | 查询“.餐厅”、“.商标”域名资质审核详情。 |
| GetOperationOssUploadPolicy | 获取线下审核OSS上传策略 | 调用GetOperationOssUploadPolicy获取审核资料的存储信息。 |
其他接口
|
API |
标题 |
API概述 |
| 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 获取对应的授权策略 | 获取“.餐厅”、“.商标”域名对应的授权策略。 |
| ChangeResourceGroup | 修改域名所属资源组 | 修改域名所属的资源组。 |
| SaveBatchTaskForReserveDropListDomain | 提交批量万网域名预定任务 | 调用SaveBatchTaskForReserveDropListDomain提交批量万网域名预定任务。 |
其他
|
API |
标题 |
API概述 |
| SaveBatchTaskForTransferOutByAuthorizationCode | 基于转移码的批量转出任务提交 | 调用SaveBatchTaskForTransferOutByAuthorizationCode提交基于转移码的批量转出任务。 |
| SaveSingleTaskForTransferOutByAuthorizationCode | 基于转移码的单个转出任务提交 | 调用SaveSingleTaskForTransferOutByAuthorizationCode提交基于转移码的单个转出任务。 |
该文章对您有帮助吗？