本产品（
云解析/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 | 更新实例配置启用状态 | 调用UpdateCloudGtmInstanceConfigEnableStatus更新实例启动状态。 |
| CreateCloudGtmMonitorTemplate | 创建健康探测模板 | 调用CreateCloudGtmMonitorTemplate创建健康探测模板。 |
| UpdateCloudGtmInstanceConfigRemark | 更新实例备注信息 | 调用UpdateCloudGtmInstanceConfigRemark更新实例备注信息。 |
| DeleteCloudGtmInstanceConfig | 删除接入域名 | 调用DeleteCloudGtmInstanceConfig删除GTM 3.0实例配置的接入域名。 |
| 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 | 查询公网解析日志 |