文档

API概览

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

云解析实例

API标题API概述
DescribeDnsProductInstance获取付费版DNS产品实例详情根据实例ID获取云解析收费版本产品实例的详情信息。
DescribeDnsProductInstances获取付费版DNS产品实例列表根据传入参数获取付费版DNS产品实例列表。

域名

API标题API概述
AddDomain添加域名根据传入参数添加域名。
AddDomainBackup新建域名备份新建域名备份。
AddDomainGroup添加域名分组根据传入参数添加域名分组。
DeleteDomainGroup删除域名分组删除域名分组,分组下的域名会被移动到默认分组。
DeleteDomain删除域名根据传入参数删除域名。
ModifyHichinaDomainDNS修改域名DNS服务器名称变更域名绑定的DNS服务器名称,从其他服务商的DNS服务器名称,修改为阿里云解析DNS提供的DNS服务器名称。
UpdateDomainGroup修改域名分组根据传入参数修改域名分组名称。
UpdateDomainRemark修改域名的备注根据传入参数修改域名的备注。
ChangeDomainGroup将域名从原分组更换到新分组根据传入参数将域名从原分组更换到新分组。
SetDomainDnssecStatus设置域名DNSSEC状态开启/关闭域名的DNSSEC服务,仅支持付费版DNS用户。
DescribeDomainInfo获取域名信息根据传入参数查询指定域名的信息。
DescribeDomainLogs获取域名操作日志根据传入参数获取域名的操作日志。
DescribeDomainNs获取域名NS服务器列表根据传入域名获取域名当前的NS服务器列表,以及NS是否属于阿里云解析管理。
DescribeDomains获取域名列表根据传入参数查询该用户的域名列表。
DescribeDomainStatistics获取主域名请求量实时统计查询指定主域名请求量的实时数据。
DescribeDomainStatisticsSummary获取全部域名的请求量统计列表查询用户账号下所有付费域名的请求量列表。
DescribeRecordStatistics获取子域名请求量实时统计查询指定子域名请求量的实时数据。
DescribeRecordStatisticsSummary获取全部子域名的请求量统计查询指定域名下的全部子域名的请求量统计。
DescribeInstanceDomains获取实例绑定域名列表获取实例绑定域名列表。
DescribeTransferDomains获取跨账号转移DNS权限列表根据传入参数获取跨账号转移DNS列表。
GetMainDomainName获取主域名名称通过输入的参数,获取主域名名称。
DescribeDNSSLBSubDomains获取权重配置子域名列表根据传入参数获取权重配置子域名列表。
DescribeDomainDnssecInfo查询域名的DNSSEC信息根据传入参数查询指定域名的DNSSEC信息。
DescribeDomainGroups获取所有域名分组列表根据传入参数获取所有分组列表。
BindInstanceDomains绑定付费版DNS域名绑定付费版DNS域名到实例ID。
RetrieveDomain找回域名执行找回域名操作。
OperateBatchDomain批量管理域名和解析记录提交批量添加、删除域名、解析记录的任务。
TransferDomain跨账号转移DNS权限根据传入参数批量跨账号转移DNS权限至其他账户。
UnbindInstanceDomains解绑付费版DNS域名根据实例ID解绑付费版DNS的域名。

权威代理域名

API标题API概述
AddDnsCacheDomain添加 DNS 权威代理域名
UpdateDnsCacheDomain更新 DNS 权威代理域名
UpdateDnsCacheDomainRemark更新 DNS 权威代理域名备注
DeleteDnsCacheDomain删除 DNS 权威代理域名
DescribeDnsCacheDomains获取 DNS 权威代理域名

解析记录

API标题API概述
AddDomainRecord添加解析记录根据传入参数添加解析记录。
DeleteDomainRecord删除解析记录根据传入参数删除解析记录。
DeleteSubDomainRecords删除主机记录对应的解析记录根据传入参数删除主机记录对应的解析记录。
UpdateDomainRecord修改域名解析记录根据传入参数修改解析记录。
UpdateDomainRecordRemark修改解析记录的备注根据传入参数修改解析记录的备注。
SetDomainRecordStatus设置解析记录状态根据传入参数设置解析记录状态。
DescribeDomainRecordInfo获取解析记录的详细信息获取解析记录的详细信息。
DescribeDomainRecords获取解析记录列表根据传入参数获取指定主域名的所有解析记录列表。
DescribeRecordLogs获取解析记录操作日志根据传入参数获取域名的解析操作日志。
DescribeSubDomainRecords获取子域名解析记录列表根据传入参数获取某个固定子域名的所有解析记录列表。
GetTxtRecordForVerify生成txt记录生成txt记录。用于域名、子域名找回、添加子域名验证、批量找回等功能。

解析请求来源线路

API标题API概述
AddCustomLine添加自定义线路添加自定义线路。
DeleteCustomLines批量删除自定义线路批量删除自定义线路。
UpdateCustomLine编辑自定义线路编辑自定义线路。
DescribeCustomLine查询自定义线路查询自定义线路。
DescribeCustomLines查询自定义线路列表查询自定义线路列表。
DescribeSupportLines获取解析线路列表查询云解析支持的所有线路列表。

权重

API标题API概述
SetDNSSLBStatus开启关闭权重配置根据传入参数开启关闭权重配置。
UpdateDNSSLBWeight修改权重根据传入参数修改解析记录的权重。

批量处理

API标题API概述
DescribeBatchResultCount查询一次批量操作任务的执行结果查询一次批量操作任务的执行结果。
DescribeBatchResultDetail查询批量处理结果的详细信息查询批量处理结果的详细信息。

资源

API标题API概述
DescribeTags查询已有标签列表查询已有标签。
ListTagResources标签查询资源按照标签查询资源。
TagResources添加修改资源标签通过进行添加、修改资源的标签。
UntagResources删除资源标签进行删除资源的标签。
MoveDomainResourceGroup更换域名资源组更换资源组。

GTM 实例

API标题API概述
SetGtmAccessMode修改生效地址池切换策略(旧版)根据传入参数修改生效地址池切换策略。
UpdateDnsGtmInstanceGlobalConfig修改GTM实例全局配置修改实例配置。
UpdateGtmInstanceGlobalConfig修改GTM实例全局配置(旧版)根据传入参数修改GTM实例配置。
UpdateDnsGtmAccessStrategy修改访问策略修改访问策略。
DescribeDnsGtmAddrAttributeInfo查询地址归属区域信息查询地址归属区域。
DescribeDnsGtmAvailableAlertGroup获取GTM实例可用的报警组列表获取可设置的报警组。
DescribeDnsGtmInstance获取GTM实例详情获取实例详情。
DescribeGtmInstance获取GTM实例详情(旧版)获取GTM实例的详情信息。
DescribeDnsGtmInstances获取GTM实例列表获取实例列表。
DescribeGtmInstances获取GTM实例列表(旧版)获取GTM实例列表。
DescribeDnsGtmInstanceStatus获取GTM实例状态获取实例当前状态。
DescribeGtmInstanceStatus获取GTM实例状态(旧版)获取实例的当前状态。
DescribeDnsGtmLogs获取GTM操作日志列表获取操作日志列表。
DescribeGtmAvailableAlertGroup获取GTM实例可用的报警组列表(旧版)获取GTM实例可用的报警组列表。
DescribeGtmLogs获取GTM操作日志列表(旧版)获取日志列表。
DescribeGtmInstanceSystemCname获取系统分配的CNAME域名(旧版)获取系统分配的cname域名。
DescribeDnsGtmInstanceSystemCname获取系统分配的CNAME域名获取系统分配的CNAME域名。
CopyGtmConfig复制GTM配置复制GTM配置。
MoveGtmResourceGroup修改GTM实例的资源组ID

地址池

API标题API概述
AddGtmAddressPool新增地址池(旧版)新增地址池。
AddDnsGtmAddressPool新增地址池新增地址池。
DeleteDnsGtmAddressPool删除 DNS 地址池删除地址池。
DeleteGtmAddressPool删除地址池(旧版)删除地址池。
UpdateDnsGtmAddressPool修改地址池修改地址池。
UpdateGtmAddressPool修改地址池(旧版)修改地址池。
DescribeDnsGtmInstanceAddressPool获取地址池详情获取地址池详情。
DescribeDnsGtmInstanceAddressPools获取地址池列表获取地址池列表。
DescribeDnsGtmAddressPoolAvailableConfig获取地址池可设置配置信息获取地址池可设置配置。
DescribeGtmInstanceAddressPool获取地址池详细信息(旧版)获取地址池详细信息。
DescribeGtmInstanceAddressPools获取GTM实例地址池列表(旧版)获取GTM实例地址池列表。

健康检查

API标题API概述
AddDnsGtmMonitor添加健康检查创建健康检查。
AddGtmMonitor添加健康检查(旧版)创建健康检查。
UpdateDnsGtmMonitor修改健康检查修改健康检查。
UpdateGtmMonitor修改健康检查(旧版)修改健康检查。
SetDnsGtmMonitorStatus设置 DNS 地址池健康检查状态设置地址池健康检查状态。
SetGtmMonitorStatus设置地址池健康检查状态(旧版)设置地址池健康检查状态。
DescribeGtmMonitorAvailableConfig获取健康检查可设置的配置(旧版)获取健康检查可设置的配置。
DescribeGtmMonitorConfig获取地址池健康检查配置(旧版)获取地址池健康检查配置。
DescribeDnsGtmMonitorAvailableConfig获取 DNS 健康检查可设置的配置获取健康检查可设置的配置。
DescribeDnsGtmMonitorConfig获取 DNS 地址池健康检查配置获取地址池健康检查配置。

访问策略

API标题API概述
AddDnsGtmAccessStrategy新增访问策略新增访问策略。
AddGtmAccessStrategy新增访问策略(旧版)根据传入参数新增访问策略。
DeleteDnsGtmAccessStrategy删除访问策略删除访问策略。
DeleteGtmAccessStrategy删除访问策略(旧版)根据传入参数删除访问策略。
UpdateGtmAccessStrategy修改访问策略(旧版)根据传入参数修改访问策略。
SetDnsGtmAccessMode修改生效地址池切换策略调整访问策略。
DescribeDnsGtmAccessStrategies获取实例访问策略列表获取实例访问策略列表。
DescribeDnsGtmAccessStrategy获取访问策略详细信息获取访问策略详细信息。
DescribeDnsGtmAccessStrategyAvailableConfig获取访问策略可设置的配置获取访问策略可设置的配置。
DescribeGtmAccessStrategies获取实例访问策略列表(旧版)获取当前实例的访问策略列表。
DescribeGtmAccessStrategy获取访问策略详细信息(旧版)根据策略ID获取策略详细信息。
DescribeGtmAccessStrategyAvailableConfig获取访问策略可设置的配置(旧版)获取当前访问策略可设置的配置。
SwitchDnsGtmInstanceStrategyMode切换访问策略类型切换访问策略类型。

DoH 域名

API标题API概述
DescribeDohAccountStatistics获取DoH账户请求量统计概览获取DoH账户请求量统计概览。
DescribeDohDomainStatistics获取DoH域名请求量统计概览获取DoH域名请求量统计概览。
DescribeDohDomainStatisticsSummary获取DoH域名的请求量统计列表获取DoH域名的请求量统计列表。
DescribeDohSubDomainStatistics获取DoH子域名请求量统计获取DoH子域名请求量统计。
DescribeDohSubDomainStatisticsSummary获取DoH子域名的请求量统计列表获取DoH子域名的请求量统计列表。
DescribeDohUserInfo获取DoH用户基本信息获取DoH用户基本信息。

容灾

API标题API概述
AddGtmRecoveryPlan新增容灾预案新增容灾预案。
DeleteGtmRecoveryPlan删除容灾预案删除容灾预案。
UpdateGtmRecoveryPlan修改容灾预案修改容灾预案。
DescribeGtmRecoveryPlan获取容灾预案详情获取容灾预案详情。
DescribeGtmRecoveryPlanAvailableConfig获取容灾预案可设置的配置获取容灾预案可设置的配置。
DescribeGtmRecoveryPlans获取容灾预案列表获取容灾预案列表。
ExecuteGtmRecoveryPlan执行容灾预案执行容灾预案。
PreviewGtmRecoveryPlan预览容灾预案预览容灾预案。
RollbackGtmRecoveryPlan回滚容灾预案回滚容灾预案。

GTM3.0

API标题API概述
DescribeCloudGtmInstanceConfigFullInfo获取实例配置完整信息调用DescribeCloudGtmInstanceConfigFullInfo获取全局流量管理实例配置的完整信息,包括接入域名、告警通知、地址池、地址详细信息等。
ListCloudGtmAddressPools获取地址池列表调用ListCloudGtmAddressPools获取地址池列表。
ListCloudGtmInstanceConfigs获取实例配置列表调用ListCloudGtmInstanceConfigs获取实例配置列表,包括接入域名、地址池信息等。
SearchCloudGtmMonitorTemplates搜索健康检查模板列表调用SearchCloudGtmMonitorTemplates查询健康检查模板列表信息。
UpdateCloudGtmAddressRemark修改地址备注调用UpdateCloudGtmAddressRemark修改地址备注信息。
CreateCloudGtmAddress创建地址调用CreateCloudGtmAddress创建地址。
UpdateCloudGtmAddress修改地址健康状态判定条件调用UpdateCloudGtmAddress修改指定地址健康状态判定条件。
UpdateCloudGtmAddressEnableStatus修改地址启用状态调用UpdateCloudGtmAddressEnableStatus修改地址启用状态。
UpdateCloudGtmAddressManualAvailableStatus修改地址探测异常切换方式调用UpdateCloudGtmAddressManualAvailableStatus修改地址探测异常切换方式。
UpdateCloudGtmAddressPoolEnableStatus修改地址池启用状态调用UpdateCloudGtmAddressPoolEnableStatus修改地址池启用状态。
CreateCloudGtmAddressPool创建地址池调用CreateCloudGtmAddressPool创建地址池。
UpdateCloudGtmAddressPoolRemark修改地址池备注调用UpdateCloudGtmAddressPoolRemark修改地址池备注信息。
DeleteCloudGtmAddressPool删除地址池调用DeleteCloudGtmAddressPool删除地址池。
UpdateCloudGtmAddressPoolLbStrategy修改地址池负载均衡策略调用UpdateCloudGtmAddressPoolLbStrategy修改地址池负载均衡策略。
DeleteCloudGtmAddress删除地址调用DeleteCloudGtmAddress删除地址。
UpdateCloudGtmAddressPoolBasicConfig修改地址池健康判定条件调用UpdateCloudGtmAddressPoolBasicConfig修改地址池健康判定条件。
ReplaceCloudGtmAddressPoolAddress替换地址池引用的地址调用ReplaceCloudGtmAddressPoolAddress替换地址池引用的地址。
UpdateCloudGtmInstanceConfigBasic更新实例全局TTL配置调用UpdateCloudGtmInstanceConfigBasic更新GTM3.0 实例全局TTL配置。
UpdateCloudGtmInstanceConfigLbStrategy更新实例负载均衡策略调用UpdateCloudGtmInstanceConfigLbStrategy更新实例负载均衡策略。
ReplaceCloudGtmInstanceConfigAddressPool替换实例关联的地址池调用ReplaceCloudGtmInstanceConfigAddressPool替换实例关联的地址池。
UpdateCloudGtmInstanceConfigEnableStatus更新实例配置启用状态
CreateCloudGtmMonitorTemplate创建健康探测模板
UpdateCloudGtmInstanceConfigRemark更新实例配置备注
DeleteCloudGtmInstanceConfig删除域名实例配置
DeleteCloudGtmMonitorTemplate删除健康探测模板
UpdateCloudGtmMonitorTemplate修改健康探测模板
ListCloudGtmMonitorTemplates获取健康检查模板列表
DescribeCloudGtmMonitorTemplate获取健康检查模板配置
ListCloudGtmMonitorNodes获取健康检查探点列表
DescribeCloudGtmAddress获取地址配置信息
DescribeCloudGtmAddressPool获取地址池
DescribeCloudGtmAddressReference获取地址被引用的信息
SearchCloudGtmAddressPools搜索地址池列表
ListCloudGtmAddresses获取地址列表
ListCloudGtmInstances获取实例列表
SearchCloudGtmInstances搜索实例列表
DescribeCloudGtmAddressPoolReference获取地址池被实例引用的信息
SearchCloudGtmInstanceConfigs搜索实例配置列表
SearchCloudGtmAddresses搜索地址列表
DescribeCloudGtmSystemLines查询GTM支持的系统线路
ListCloudGtmAlertLogs获取告警日志列表
DescribeCloudGtmInstanceConfigAlert获取实例配置的告警配置
UpdateCloudGtmGlobalAlert修改全局告警配置
UpdateCloudGtmMonitorTemplateRemark修改健康探测模板备注
DescribeCloudGtmGlobalAlert获取全局告警配置
CreateCloudGtmInstanceConfig创建域名实例配置
UpdateCloudGtmInstanceConfigAlert更新实例的告警配置
UpdateCloudGtmInstanceName修改实例名称
ListCloudGtmAvailableAlertGroups获取用户可用的告警组列表
DescribeCloudGtmSummary获取实例概要信息

其他

API标题API概述
DescribeRecordResolveStatisticsSummary获取子域名的请求量统计查询指定域名下的全部子域名的请求量统计。
DescribeDomainResolveStatisticsSummary获取域名的请求量统计列表查询用户账号下所有付费域名的请求量列表。
DescribeInternetDnsLogs查询公网解析日志