更新时间:2025-11-14 GMT+08:00
分享

API概览

云解析服务提供自研的REST接口。

通过使用云解析服务的接口,您可以完整地使用云解析服务的所有功能,包括对公网域名、内网域名、记录集等资源的创建、查询、修改和删除。

云解析服务提供的具体API如表1所示。

表1 接口说明

子类型

说明

版本管理接口

DNS API的版本查询接口,支持查询所有API或者指定API的版本号。

公网域名管理接口

DNS API的公网域名管理接口,包括创建公网域名、查询公网域名列表、查询公网域名、查询创建公网域名的名称服务器、修改创建公网域名、删除创建公网域名、设置公网域名状态、创建公网域名找回、查询公网域名找回、验证公网域名找回、查询公网域名找回结果、创建公网子域名授权、查询公网子域名授权以及验证公网子域名授权。

内网域名管理接口

DNS API的内网域名管理接口,包括创建内网域名、查询内网域名列表、查询内网域名、查询内网域名的名称服务器、修改内网域名、删除内网域名、在内网域名上关联VPC、在内网域名上解关联VPC以及设置内网域名的子域名递归解析代理。

记录集管理接口(v2.1)

DNS API的记录集管理接口,包括创建记录集、查询域名下的记录集列表、查询租户记录集列表、查询记录集、修改记录集、删除记录集、设置记录集状态、查询公网域名的线路列表、查询系统线路、批量创建记录集、查询批量创建记录集、删除批量创建记录集任务、批量线路创建记录集、批量修改记录集以及批量删除域名下的记录集。

记录集管理接口(v2)

DNS API的记录集管理接口,包括创建记录集、查询域名下的记录集列表、查询租户记录集列表、查询记录集、修改记录集以及删除记录集。

反向解析管理接口(v2.1)

DNS API的反向解析管理接口,包括创建弹性公网IP的反向解析、查询弹性公网IP的反向解析列表、查询弹性公网IP的反向解析、修改弹性公网IP的反向解析以及将弹性公网IP的反向解析记录恢复为默认值。

反向解析管理接口(v2)

DNS API的反向解析管理接口,包括创建弹性公网IP的反向解析、查询弹性公网IP的反向解析列表、查询弹性公网IP的反向解析、修改弹性公网IP的反向解析以及将弹性公网IP的反向解析记录恢复为默认值。

批量操作接口

DNS API的批量接口管理,包括批量删除域名、批量删除记录集、批量删除反向解析、批量设置域名状态、批量设置记录集状态、批量创建公网域名、批量创建公网记录集、批量删除公网记录集、批量修改公网记录集、批量转移公网域名、查询批量操作任务列表以及查询批量操作任务。

DNSSEC接口

DNS API的DNSSEC接口,包括开启DNSSEC、关闭DNSSEC、查询DNSSEC。

公网域名检测接口

DNS API的公网域名检测接口,包括查询公网域名的域名诊断、查询公网域名的邮箱域名、查询公网域名的网站域名、查询公网域名的DNS服务器地址。

自定义线路管理接口

DNS API的自定义线路管理接口,包括创建自定义线路、查询自定义线路、修改自定义线路、删除自定义线路、创建线路分组、查询线路分组列表、查询线路分组、删除线路分组以及修改线路分组。

解析器管理接口

DNS API的解析器管理接口,包括创建终端节点、查询终端节点列表、查询终端节点、修改终端节点、删除终端节点、终端节点绑定IP地址、查询IP地址列表、终端节点解绑IP地址、查询终端节点VPC列表、创建解析器转发规则、查询解析器转发规则列表、查询解析器转发规则、删除解析器转发规则、解析器转发规则关联VPC以及解析器转发规则解关联VPC。

访问日志管理接口

DNS API的访问日志管理接口,包括创建解析器访问日志、查询解析器访问日志列表、查询解析器访问日志、删除解析器访问日志、解析器访问日志关联VPC、解析器访问日志解关联VPC。

标签管理接口

DNS API的标签管理接口,包括为指定实例添加标签、删除资源标签、为指定实例批量添加或删除标签、查询指定实例的标签信息、查询指定实例类型的所有标签集合、使用标签查询资源实例。

名称服务器管理接口

DNS API的名称服务器管理接口,支持查询名称服务器列表。

配额管理接口

DNS API的配额管理接口,支持查询租户配额。

版本管理接口

表2 版本管理接口

API

说明

查询API版本信息列表 - ListApiVersions

查询所有DNS API接口的版本。

查询指定版本号的API版本信息 - ShowApiInfo

查询指定DNS API接口的版本。

公网域名管理接口

表3 公网域名管理接口

API

说明

创建公网域名 - CreatePublicZone

创建单个公网域名。

查询公网域名列表 - ListPublicZones

查询公网域名列表。

查询公网域名 - ShowPublicZone

查询单个公网域名。

查询公网域名的名称服务器 - ShowPublicZoneNameServer

查询单个公网域名的名称服务器。

修改公网域名 - UpdatePublicZone

修改单个公网域名。

删除公网域名 - DeletePublicZone

删除单个公网域名。

设置公网域名状态 - UpdatePublicZoneStatus

设置单个公网域名状态。

创建公网域名找回 - CreateRetrieval

创建公网域名找回。

查询公网域名找回 - ShowRetrieval

查询公网域名找回。

验证公网域名找回 - CreateRetrievalVerification

验证公网域名找回。

查询公网域名找回结果 - ShowRetrievalVerification

查询公网域名找回结果。

创建公网子域名授权 - CreateAuthorizeTxtRecord

创建公网子域名授权。

查询公网子域名授权 - ShowAuthorizeTxtRecord

查询公网子域名授权。

验证公网子域名授权 - CreateAuthorizeTxtRecordVerification

验证公网子域名授权。

内网域名管理接口

表4 内网域名管理接口

API

说明

创建内网域名 - CreatePrivateZone

创建单个内网域名。

查询内网域名列表 - ListPrivateZones

查询内网域名列表。

查询内网域名 - ShowPrivateZone

查询单个内网域名。

查询内网域名的名称服务器 - ShowPrivateZoneNameServer

查询内网域名的名称服务器。

修改内网域名 - UpdatePrivateZone

修改单个内网域名。

删除内网域名 - DeletePrivateZone

删除单个内网域名。

在内网域名上关联VPC - AssociateRouter

为内网域名关联VPC。

在内网域名上解关联VPC - DisassociateRouter

为内网域名解关联VPC。

设置内网域名状态 - UpdatePrivateZoneStatus

设置内网域名状态。

设置内网域名的子域名递归解析代理 - SetPrivateZoneProxyPattern

设置内网域名的子域名递归解析代理。

记录集管理接口(v2.1)

表5 记录集管理接口

API

说明

创建记录集 - CreateRecordSetWithLine

创建单个记录集。

查询域名下的记录集列表 - ShowRecordSetByZone

查询单个域名的记录集列表。

查询租户记录集列表 - ListRecordSetsWithLine

查询租户记录集资源列表。

查询记录集 - ShowRecordSetWithLine

查询单个记录集。

修改记录集 - UpdateRecordSets

修改单个记录集。

删除记录集 - DeleteRecordSets

删除单个记录集。

设置记录集状态 - SetRecordSetsStatus

设置记录集状态。

查询公网域名的线路列表 - ListPublicZoneLines

查询公网域名的线路列表。

查询系统线路 - ListSystemLines

查询系统线路。

批量创建记录集 - BatchCreateRecordSetsTask

批量创建记录集。

查询批量创建记录集任务 - ShowBatchCreateRecordSetsTask

查询批量创建记录集任务。

删除批量创建记录集任务 - DeleteBatchCreateRecordSetsTask

删除批量创建记录集任务。

批量线路创建记录集 - CreateRecordSetWithBatchLines

批量线路创建记录集。

批量修改记录集 - BatchUpdateRecordSetWithLine

批量修改记录集。

批量删除域名下的记录集 - BatchDeleteRecordSetWithLine

批量删除域名下的记录集。

记录集管理接口(v2)

DNS API的记录集管理接口,用于创建、删除、修改、查询记录集。

表6 记录集管理接口

API

说明

创建记录集 - CreateRecordSet

创建单个记录集。

查询域名下的记录集列表 - ListRecordSetsByZone

查询单个域名的记录集列表。

查询租户记录集列表 - ListRecordSets

查询租户记录集资源列表。

查询记录集 - ShowRecordSet

查询单个记录集。

修改记录集 - UpdateRecordSet

修改单个记录集。

删除记录集 - DeleteRecordSet

删除单个记录集。

反向解析管理接口(v2.1)

表7 反向解析管理接口

API

说明

创建弹性公网IP的反向解析记录 - CreatePtr

设置弹性IP的PTR记录。

查询弹性公网IP的反向解析记录列表 - ListPtrs

查询租户弹性IP的PTR记录列表。

查询弹性公网IP的反向解析记录 - ShowPtr

查询单个弹性IP的PTR记录。

修改弹性公网IP的反向解析记录 - UpdatePtr

修改弹性IP的PTR记录。

将弹性公网IP的反向解析记录恢复为默认值 - DeletePtr

将弹性IP的PTR记录恢复为默认值。

反向解析管理接口(v2)

表8 反向解析管理接口

API

说明

设置弹性公网IP的反向解析记录 - CreateEipRecordSet

设置弹性IP的PTR记录。

查询弹性公网IP的反向解析记录列表 - ListPtrRecords

查询租户弹性IP的PTR记录列表。

查询弹性公网IP的反向解析记录 - ShowPtrRecordSet

查询单个弹性IP的PTR记录。

修改弹性公网IP的反向解析记录 - UpdatePtrRecord

修改弹性IP的PTR记录。

将弹性公网IP的反向解析记录恢复为默认值 - RestorePtrRecord

将弹性IP的PTR记录恢复为默认值。

DNSSEC接口

表10 DNSSEC接口

API

说明

开启DNSSEC - EnableDnssecConfig

开启公网域名的DNSSEC功能。

关闭DNSSEC - DisableDnssecConfig

关闭公网域名的DNSSEC功能。

查询DNSSEC - ShowDnssecConfig

查询公网域名的DNSSEC信息。

公网域名检测接口

表11 公网域名检测接口

API

说明

查询公网域名的域名诊断 - ShowDomainDetection

查询公网域名的域名诊断。

查询公网域名的邮箱域名 - ShowEmailRecordSet

查询公网域名的邮箱域名。

查询公网域名的网站域名 - ShowWebsiteRecordSet

查询公网域名的网站域名。

查询公网域名的DNS服务器地址 - ShowZoneNameServer

查询公网域名的DNS服务器地址。

自定义线路管理接口

表12 自定义线路管理接口

API

说明

创建自定义线路 - CreateCustomLine

创建单个自定义线路。

查询自定义线路 - ListCustomLine

查询自定义线路。

修改自定义线路 - UpdateCustomLine

更新单个自定义线路。

删除自定义线路 - DeleteCustomLine

删除单个自定义线路。

创建线路分组 - CreateLineGroup

创建线路分组。

查询线路分组列表 - ListLineGroups

查询线路分组列表。

查询线路分组 - ShowLineGroup

查询线路分组。

修改线路分组 - UpdateLineGroups

更新线路分组。

删除线路分组 - DeleteLineGroup

删除线路分组。

解析器管理接口

表13 解析器管理接口

API

说明

创建终端节点 - CreateEndpoint

创建终端节点。

查询终端节点列表 - ListEndpoints

查询终端节点列表。

查询终端节点 - ShowEndpoint

查询终端节点。

修改终端节点 - UpdateEndpoint

修改终端节点。

删除终端节点 - DeleteEndpoint

删除终端节点。

终端节点绑定IP地址 - AssociateEndpointIpaddress

终端节点绑定IP地址。

查询IP地址列表 - ListEndpointIpaddresses

查询IP地址列表。

终端节点解绑IP地址 - DisassociateEndpointIpaddress

终端节点解绑IP地址。

查询终端节点VPC列表 - ListEndpointVpcs

查询终端节点VPC列表。

创建解析器转发规则 - CreateResolverRule

创建解析器转发规则。

查询解析器转发规则列表 - ListResolverRules

查询解析器转发规则列表。

查询解析器转发规则 - ShowResolverRule

查询解析器转发规则。

修改解析器转发规则 - UpdateResolverRule

修改解析器转发规则。

删除解析器转发规则 - DeleteResolverRule

删除解析器转发规则。

解析器转发规则关联VPC - AssociateResolverRuleRouter

解析器转发规则关联VPC。

解析器转发规则解关联VPC - DisassociateResolverRuleRouter

解析器转发规则解关联VPC。

访问日志管理接口

表14 访问日志管理接口

API

说明

创建解析器访问日志 - CreateResolverQueryLogConfig

创建解析器访问日志。

查询解析器访问日志列表 - ListResolverQueryLogConfigs

查询解析器访问日志列表。

查询解析器访问日志 - ShowResolverQueryLogConfig

查询解析器访问日志。

删除解析器访问日志 - DeleteResolverQueryLogConfig

删除解析器访问日志。

解析器访问日志关联VPC - AssociateResolverQueryLogConfig

解析器访问日志关联VPC。

解析器访问日志解关联VPC - DisassociateResolverQueryLogConfig

解析器访问日志解关联VPC。

标签管理接口

表15 标签管理接口

API

说明

为指定实例添加标签 - CreateTag

为指定实例添加标签。

删除资源标签 - DeleteTag

删除资源标签。

为指定实例批量添加或删除标签 - BatchCreateTag

为指定实例批量添加或删除标签。

查询指定实例的标签信息 - ShowResourceTag

查询指定实例的标签信息。

查询指定实例类型的所有标签集合 - ListTags

查询指定实例类型的所有标签集合。

使用标签查询资源实例 - ListTag

使用标签查询资源实例。

资源实例按照创建时间倒序。

名称服务器管理接口

表16 名称服务器管理接口

API

说明

查询名称服务器列表 - ListNameServers

查询名称服务器列表。

配额管理接口

表17 配额管理接口

API

说明

查询租户配额 - ShowDomainQuota

查询DNS资源配额。

相关文档