API概览

本产品(Alidns/2015-01-09)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

云解析实例

API

标题

API概述

DescribeDnsProductInstance 获取付费版DNS产品实例详情 根据实例ID获取云解析收费版本产品实例的详情信息。
DescribeDnsProductInstances 获取付费版DNS产品实例列表 根据传入参数获取付费版DNS产品实例列表。
DescribeInstanceDomains 获取实例绑定域名列表 获取实例绑定域名列表。

域名

API

标题

API概述

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

解析记录

API

标题

API概述

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

自定义线路

API

标题

API概述

AddCustomLine 添加自定义线路 给域名添加自定义线路。
DeleteCustomLines 批量删除自定义线路 通过自定义线路唯一ID批量删除自定义线路。
UpdateCustomLine 编辑自定义线路 通过自定义线路唯一ID编辑自定义线路。
DescribeCustomLine 查询自定义线路 通过自定义线路唯一ID查询自定义线路。
DescribeCustomLines 查询自定义线路列表 通过域名名称查询自定义线路列表。
DescribeSupportLines 获取解析线路列表 查询云解析支持的所有线路列表。

权重

API

标题

API概述

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

批量处理

API

标题

API概述

DescribeBatchResultCount 查询某次批量操作任务的执行结果 根据任务ID查询其批量操作任务的执行结果,如果任务ID为空,返回最后一次批量操作任务的执行结果。
DescribeBatchResultDetail 查询批量处理结果的详细信息 查询批量处理结果的详细信息。

标签与资源组

API

标题

API概述

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

权威代理域名

API

标题

API概述

AddDnsCacheDomain 添加 DNS 权威代理域名 根据传入参数添加 DNS 权威代理域名。
UpdateDnsCacheDomain 更新 DNS 权威代理域名 根据传入参数更新 DNS 权威代理域名。
UpdateDnsCacheDomainRemark 更新 DNS 权威代理域名备注 更新目标域名的DNS 权威代理域名备注。
DeleteDnsCacheDomain 删除 DNS 权威代理域名 删除指定的DNS权威代理域名。
DescribeDnsCacheDomains 获取 DNS 权威代理域名 根据传入参数查询该用户的权威代理域名列表。

GTM3.0

API

标题

API概述

GTM Instances GTM Instances
DescribeCloudGtmInstanceConfigFullInfo 获取实例配置完整信息 获取全局流量管理实例配置的完整信息,包括接入域名、告警通知、地址池、地址详细信息等。
ListCloudGtmInstanceConfigs 获取实例配置列表 获取实例配置列表,包括接入域名、地址池信息等。
DeleteCloudGtmInstanceConfig 删除接入域名 根据传入参数删除GTM 3.0实例配置的接入域名。
UpdateCloudGtmInstanceConfigBasic 更新实例全局TTL配置 根据传入参数更新GTM3.0 实例全局TTL配置。
UpdateCloudGtmInstanceConfigLbStrategy 更新实例负载均衡策略 根据传入参数更新实例负载均衡策略。
UpdateCloudGtmInstanceConfigEnableStatus 更新实例配置启用状态 根据传入参数更新实例启动状态。
UpdateCloudGtmInstanceConfigRemark 更新实例备注信息 根据传入的参数更新实例备注信息。
ListCloudGtmInstances 获取实例列表 根据传入参数获取GTM 3.0实例列表。
SearchCloudGtmInstances 搜索实例列表 根据传入参数搜索实例列表。
SearchCloudGtmInstanceConfigs 搜索实例配置列表 根据传入参数搜索实例配置列表。
GTM Address GTM Address
CreateCloudGtmAddress 创建地址 根据传入参数创建地址。
UpdateCloudGtmAddress 修改地址基础配置 调用UpdateCloudGtmAddress修改指定地址基础配置。
DescribeCloudGtmAddress 获取地址配置信息 根据传入参数获取地址配置信息。
DeleteCloudGtmAddress 删除地址 根据传入参数删除地址。
UpdateCloudGtmAddressRemark 修改地址备注 通过地址的 ID修改地址备注信息。
ListCloudGtmAddresses 获取地址列表 根据传入参数获取地址列表。
SearchCloudGtmAddresses 搜索地址列表 按照地址名称、备注信息、地址引用的探测模板或地址DI等信息搜索地址列表。
DescribeCloudGtmAddressReference 获取地址被引用的信息 根据传入参数获取地址被引用的地址池、GTM3.0实例信息。
UpdateCloudGtmAddressEnableStatus 修改地址启用状态 根据传入参数修改地址启用状态。
UpdateCloudGtmAddressManualAvailableStatus 修改地址探测异常切换方式 根据传入参数修改地址探测异常切换方式。
GTM AddressPool GTM AddressPool
CreateCloudGtmAddressPool 创建地址池 根据传入参数创建地址池。
ListCloudGtmAddressPools 获取地址池列表 获取地址池列表。
DescribeCloudGtmAddressPool 获取地址池配置信息 根据传入参数获取指定地址池配置信息。
DeleteCloudGtmAddressPool 删除地址池 根据传入参数删除地址池。
SearchCloudGtmAddressPools 搜索地址池列表 根据传入参数搜索地址池列表。
ReplaceCloudGtmInstanceConfigAddressPool 替换实例关联的地址池 根据传入参数替换实例关联的地址池。
UpdateCloudGtmAddressPoolEnableStatus 修改地址池启用状态 根据传入参数修改地址池启用状态。
UpdateCloudGtmAddressPoolRemark 修改地址池备注 根据传入参数修改地址池备注信息。
UpdateCloudGtmAddressPoolLbStrategy 修改地址池负载均衡策略 根据传入参数修改地址池负载均衡策略。
UpdateCloudGtmAddressPoolBasicConfig 修改地址池基础配置 根据传入参数修改地址池基础配置。
ReplaceCloudGtmAddressPoolAddress 替换地址池引用的地址 根据传入参数替换地址池引用的地址。
DescribeCloudGtmAddressPoolReference 获取地址池被实例引用的信息 根据传入参数获取地址池被实例引用的信息。
GTM Monitor GTM Monitor
SearchCloudGtmMonitorTemplates 搜索健康检查模板列表 查询健康检查模板列表信息。
CreateCloudGtmMonitorTemplate 创建健康探测模板 根据传入参数创建健康探测模板。
DeleteCloudGtmMonitorTemplate 删除健康探测模板 根据传入参数删除健康探测模板。
UpdateCloudGtmMonitorTemplate 修改健康探测模板 根据传入参数修改探测模板信息。
ListCloudGtmMonitorTemplates 获取健康探测模板列表 根据传入参数获取健康探测模板列表。
DescribeCloudGtmMonitorTemplate 获取指定健康探测模板配置 根据传入参数获取指定健康探测模板配置。
ListCloudGtmMonitorNodes 获取健康检查探点列表 根据传入参数获取健康探测检查探点列表。
DescribeCloudGtmSystemLines 查询GTM支持的系统线路 查询GTM支持的系统线路
ListCloudGtmAlertLogs 获取告警日志列表 获取告警日志列表
DescribeCloudGtmInstanceConfigAlert 获取实例配置的告警配置 获取实例配置的告警配置

GTM

API

标题

API概述

GTM 实例 GTM 实例
SetGtmAccessMode 修改生效地址池切换策略(旧版) 根据传入参数修改生效地址池切换策略。
UpdateDnsGtmInstanceGlobalConfig 修改GTM实例全局配置 通过GTM实例ID修改实例配置。
UpdateGtmInstanceGlobalConfig 修改GTM实例全局配置(旧版) 根据传入参数修改GTM实例配置。
UpdateDnsGtmAccessStrategy 修改访问策略 修改访问策略。
DescribeDnsGtmAddrAttributeInfo 查询地址归属区域信息 查询地址归属区域。
DescribeDnsGtmAvailableAlertGroup 获取GTM实例可用的报警组列表 获取可设置的报警组。
DescribeDnsGtmInstance 获取GTM实例详情 通过实例ID获取实例详情。
DescribeGtmInstance 获取GTM实例详情(旧版) 获取GTM实例的详情信息。
DescribeDnsGtmInstances 获取GTM实例列表 获取实例列表。
DescribeGtmInstances 获取GTM实例列表(旧版) 获取GTM实例列表。
DescribeDnsGtmInstanceStatus 获取GTM实例状态 通过实例ID获取实例当前状态。
DescribeGtmInstanceStatus 获取GTM实例状态(旧版) 获取实例的当前状态。
DescribeDnsGtmLogs 获取GTM操作日志列表 通过实例ID获取操作日志列表。
DescribeGtmAvailableAlertGroup 获取GTM实例可用的报警组列表(旧版) 获取GTM实例可用的报警组列表。
DescribeGtmLogs 获取GTM操作日志列表(旧版) 获取日志列表。
DescribeGtmInstanceSystemCname 获取系统分配的CNAME域名(旧版) 获取系统分配的cname域名。
DescribeDnsGtmInstanceSystemCname 获取系统分配的CNAME域名 通过实例ID获取系统分配的CNAME域名。
CopyGtmConfig 复制GTM配置 复制GTM配置。
MoveGtmResourceGroup 修改GTM实例的资源组ID 根据传入参数修改GTM实例的资源组ID。
地址池 地址池
AddGtmAddressPool 新增地址池(旧版) 新增地址池。
AddDnsGtmAddressPool 新增地址池 新增地址池。
DeleteDnsGtmAddressPool 删除 DNS 地址池 通过地址池ID删除地址池。
DeleteGtmAddressPool 删除地址池(旧版) 删除地址池。
UpdateDnsGtmAddressPool 修改地址池 根据填写的参数修改地址池。
UpdateGtmAddressPool 修改地址池(旧版) 修改地址池。
DescribeDnsGtmInstanceAddressPool 获取地址池详情 通过地址池ID获取地址池详情。
DescribeDnsGtmInstanceAddressPools 获取地址池列表 通过GTM实例ID获取地址池列表。
DescribeDnsGtmAddressPoolAvailableConfig 获取地址池可设置配置信息 通过GTM实例ID获取地址池可设置配置。
DescribeGtmInstanceAddressPool 获取地址池详细信息(旧版) 获取地址池详细信息。
DescribeGtmInstanceAddressPools 获取GTM实例地址池列表(旧版) 获取GTM实例地址池列表。
健康检查 健康检查
AddDnsGtmMonitor 添加健康检查 创建健康检查。
AddGtmMonitor 添加健康检查(旧版) 创建健康检查。
UpdateDnsGtmMonitor 修改健康检查 修改健康检查。
UpdateGtmMonitor 修改健康检查(旧版) 修改健康检查。
SetDnsGtmMonitorStatus 设置 DNS 地址池健康检查状态 设置地址池健康检查状态。
SetGtmMonitorStatus 设置地址池健康检查状态(旧版) 设置地址池健康检查状态。
DescribeGtmMonitorAvailableConfig 获取健康检查可设置的配置(旧版) 获取健康检查可设置的配置。
DescribeGtmMonitorConfig 获取地址池健康检查配置(旧版) 获取地址池健康检查配置。
DescribeDnsGtmMonitorAvailableConfig 获取 DNS 健康检查可设置的配置 获取 DNS 健康检查可设置的配置。
DescribeDnsGtmMonitorConfig 获取 DNS 地址池健康检查配置 获取地址池健康检查配置。
访问策略 访问策略
AddDnsGtmAccessStrategy 新增访问策略 新增访问策略。
AddGtmAccessStrategy 新增访问策略(旧版) 根据传入参数新增访问策略。
DeleteDnsGtmAccessStrategy 删除访问策略 通过策略ID删除访问策略。
DeleteGtmAccessStrategy 删除访问策略(旧版) 根据传入参数删除访问策略。
UpdateGtmAccessStrategy 修改访问策略(旧版) 根据传入参数修改访问策略。
SetDnsGtmAccessMode 修改生效地址池切换策略 调整生效地址池访问策略。
DescribeDnsGtmAccessStrategies 获取实例访问策略列表 通过实例ID获取实例访问策略列表。
DescribeDnsGtmAccessStrategy 获取访问策略详细信息 通过访问策略ID获取访问策略详细信息。
DescribeDnsGtmAccessStrategyAvailableConfig 获取访问策略可设置的配置 通过实例ID获取访问策略可设置的配置。
DescribeGtmAccessStrategies 获取实例访问策略列表(旧版) 获取当前实例的访问策略列表。
DescribeGtmAccessStrategy 获取访问策略详细信息(旧版) 根据策略ID获取策略详细信息。
DescribeGtmAccessStrategyAvailableConfig 获取访问策略可设置的配置(旧版) 获取当前访问策略可设置的配置。
SwitchDnsGtmInstanceStrategyMode 切换访问策略类型 通过实例ID切换访问策略类型。
容灾 容灾
AddGtmRecoveryPlan 新增容灾预案 新增容灾预案。
DeleteGtmRecoveryPlan 删除容灾预案 删除容灾预案。
UpdateGtmRecoveryPlan 修改容灾预案 修改容灾预案。
DescribeGtmRecoveryPlan 获取容灾预案详情 获取容灾预案详情。
DescribeGtmRecoveryPlanAvailableConfig 获取容灾预案可设置的配置 获取容灾预案可设置的配置。
DescribeGtmRecoveryPlans 获取容灾预案列表 获取容灾预案列表。
ExecuteGtmRecoveryPlan 执行容灾预案 执行容灾预案。
PreviewGtmRecoveryPlan 预览容灾预案 预览容灾预案。
RollbackGtmRecoveryPlan 回滚容灾预案 回滚容灾预案。

HTTPDNS

API

标题

API概述

AddRecursionZone 新增HTTPDNS内置权威域名zone 新增递归解析内置权威域名zone
DescribeRecursionZone 查询HTTPDNS内置权威域名zone详情 查询递归解析内置权威域名zone详情
ListRecursionZones 查询HTTPDNS内置权威域名zone 查询递归解析内置权威域名zone
DeleteRecursionZone 删除HTTPDNS内置权威域名zone 删除递归解析内置权威域名zone
SearchRecursionZones 搜索HTTPDNS内置权威域名zone 搜索递归解析内置权威域名zone
UpdateRecursionZoneEffectiveScope 修改HTTPDNS内置权威域名zone生效范围 修改HTTPDNS内置权威域名zone生效范围
UpdateRecursionZoneRemark 修改HTTPDNS内置权威域名zone备注 修改递归解析内置权威域名zone备注
UpdateRecursionZoneProxyPattern 修改HTTPDNS内置权威域名zone递归代理模式 修改递归解析内置权威域名zone递归代理模式
AddRecursionRecord 新增HTTPDNS内置权威解析记录 新增递归解析内置权威解析记录。
DescribeRecursionRecord 查询HTTPDNS内置权威解析记录详情 查询递归解析内置权威解析记录详情
UpdateRecursionRecord 修改HTTPDNS内置权威解析记录 修改递归解析内置权威解析记录
ListRecursionRecords 查询HTTPDNS内置权威解析记录 查询递归解析内置权威解析记录
DeleteRecursionRecord 删除HTTPDNS内置权威解析记录 删除递归解析内置权威解析记录
SearchRecursionRecords 搜索HTTPDNS内置权威解析记录 搜索递归解析内置权威解析记录
UpdateRecursionRecordEnableStatus 修改HTTPDNS内置权威解析记录启用状态 修改内置权威解析记录启用状态
UpdateRecursionRecordWeight 修改HTTPDNS内置权威解析记录权重 修改递归解析内置权威解析记录权重
UpdateRecursionRecordWeightEnableStatus 修改HTTPDNS内置权威解析记录权重算法启用状态 修改递归解析内置权威解析记录权重算法启用状态
UpdateRecursionRecordRemark 修改HTTPDNS内置权威解析记录备注 修改HTTPDNS内置权威解析记录备注

DoH 域名

API

标题

API概述

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

PdnsAppKey

API

标题

API概述

CreatePdnsAppKey 创建公共DNS密钥AccessKey 创建公共DNS密钥 AccessKey。

其他

API

标题

API概述

DescribePdnsUserInfo 获取公共DNS用户信息 获取公共DNS用户信息。
DescribePdnsRequestStatistic 查询公共DNS请求量统计数据 查询公共DNS的请求量列表。
DescribePdnsRequestStatistics 查询公共DNS请求量统计数据列表 查询指定子域名请求量的统计数据。
DescribeRecordResolveStatisticsSummary 获取子域名的请求量统计 查询指定域名下的全部子域名的请求量统计。
DescribeDomainResolveStatisticsSummary 获取域名的请求量统计列表 查询用户账号下所有付费域名的请求量列表。
DescribeInternetDnsLogs 查询公网解析日志 查询解析日志