更新时间:2025-08-07 GMT+08:00

API概览

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

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

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

表1 接口说明

子类型

说明

版本管理

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

公网域名管理

DNS API的公网域名管理接口,包括创建、删除、修改、查询公网域名,以及设置公网域名状态和查询公网域名的名称服务器。

内网域名管理

DNS API的内网域名管理接口,包括创建、删除、修改、查询内网域名,以及设置内网域名状态、查询内网域名的名称服务器、在内网域名上关联VPC和解关联VPC。

记录集管理(新版本)

DNS API的记录集管理接口,包括创建、删除、修改、查询记录集,以及设置记录集状态和查询公网域名的线路列表。

记录集管理(待废弃)

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

反向解析管理(新版本)

DNS API的反向解析管理接口,包括创建、删除、修改、查询弹性公网IP的反向解析记录。

反向解析管理(待废弃)

DNS API的反向解析管理接口,实现创建、删除、修改以及查询弹性IP到域名的反向解析记录。

批量接口管理

DNS API的批量接口管理,包括批量删除域名下的记录集、批量修改记录集、批量线路创建记录集、批量删除域名、批量删除记录集、批量删除反向解析、批量设置域名状态、批量设置记录集状态。

标签管理

DNS API的标签管理接口,包括为指定实例创建、删除、修改以及查询标签,同时还支持为指定实例批量创建或删除标签。

自定义线路管理

DNS API的自定义线路管理接口,包括创建、删除、更新及查询自定义线路。

线路分组管理

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

名称服务器管理

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

配额管理

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

DNSSEC管理

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

终端节点管理

DNS API的终端节点管理接口,包括创建、删除、修改以及查询终端节点。

转发规则管理

DNS API的转发规则管理接口,包括创建、删除、修改以及查询转发规则。

版本管理接口

版本管理接口,用于查询所有DNS API版本的接口和查询指定DNS API版本的接口。

表2 版本管理接口

API

说明

查询API版本信息列表

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

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

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

公网域名管理接口

公网域名管理接口,用于创建、删除、修改、查询公网域名,以及设置公网域名状态和查询公网域名的名称服务器。

表3 公网域名管理接口

API

说明

创建公网域名

创建单个公网域名。

查询公网域名列表

查询公网域名列表。

查询公网域名

查询单个公网域名。

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

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

修改公网域名

修改单个公网域名。

删除公网域名

删除单个公网域名。

设置公网域名状态

设置单个公网域名状态。

内网域名管理接口

内网域名管理接口,用于创建、删除、修改、查询内网域名,以及设置内网域名状态、查询内网域名的名称服务器、在内网域名上关联VPC和解关联VPC。

表4 内网域名管理接口

API

说明

创建内网域名

创建单个内网域名。

查询内网域名列表

查询内网域名列表。

查询内网域名

查询单个内网域名。

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

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

修改内网域名

修改单个内网域名。

删除内网域名

删除单个内网域名。

在内网域名上关联VPC

为内网域名关联VPC。

在内网域名上解关联VPC

为内网域名解关联VPC。

设置内网域名状态

设置内网域名状态。

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

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

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

记录集管理接口,用于创建、删除、修改、查询记录集,以及设置记录集状态和查询公网域名的线路列表。

表5 记录集管理接口

API

说明

创建记录集

创建单个记录集。

查询域名下的记录集列表

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

查询租户记录集列表

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

查询记录集

查询单个记录集。

修改记录集

修改单个记录集。

删除记录集

删除单个记录集。

设置记录集状态

设置记录集状态。

查询公网域名的线路列表

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

记录集管理接口(v2)

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

表6 记录集管理接口

API

说明

创建记录集

创建单个记录集。

查询域名下的记录集列表

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

查询租户记录集列表

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

查询记录集

查询单个记录集。

修改记录集

修改单个记录集。

删除记录集

删除单个记录集。

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

反向解析管理接口,用于创建、删除、修改、查询弹性公网IP的反向解析记录。

表7 反向解析管理接口

API

说明

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

设置弹性IP的PTR记录。

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

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

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

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

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

修改弹性IP的PTR记录。

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

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

反向解析管理接口(v2)

反向解析管理接口,用于创建、删除、修改、查询弹性公网IP的反向解析记录。

表8 反向解析管理接口

API

说明

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

设置弹性IP的PTR记录。

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

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

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

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

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

修改弹性IP的PTR记录。

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

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

批量接口管理

批量接口管理,用于批量删除域名下的记录集、批量修改记录集、批量线路创建记录集、批量删除域名、批量删除记录集、批量删除反向解析、批量设置域名状态、批量设置记录集状态。

表9 批量接口管理

API

说明

批量线路创建记录集

批量线路创建记录集。

批量修改记录集

批量修改记录集。

批量删除域名下的记录集

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

批量设置域名状态

批量设置域名状态。

批量设置记录集状态

批量设置记录集状态。

批量删除域名

批量删除域名。

批量删除记录集

批量删除记录集。

批量删除反向解析

批量删除反向解析。

标签管理接口

标签管理接口,用于为指定实例创建、删除、修改以及查询标签,同时还支持为指定实例批量创建或删除标签。

表10 标签管理接口

API

说明

为指定实例添加标签

为指定实例添加标签。一个资源上最多有10个标签。

删除资源标签

删除资源标签。

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

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

查询指定实例的标签信息

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

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

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

使用标签查询资源实例

使用标签查询资源实例。资源实例按照创建时间倒序。

自定义线路管理接口

自定义线路管理接口,用于创建、删除、更新及查询自定义线路。

表11 自定义线路管理接口

API

说明

创建自定义线路

创建单个自定义线路。

查询自定义线路

查询自定义线路。

修改自定义线路

更新单个自定义线路。

删除自定义线路

删除单个自定义线路。

线路分组管理接口

线路分组管理接口,包括创建、删除、更新及查询线路分组。

表12 线路分组管理接口

API

说明

创建线路分组

创建线路分组。

查询线路分组列表

查询线路分组列表。

查询线路分组

查询线路分组。

修改线路分组

更新线路分组。

删除线路分组

删除线路分组。

名称服务器管理接口

名称服务器管理接口,用于查询名称服务器列表。

表13 名称服务器管理接口

API

说明

查询名称服务器列表

查询名称服务器列表。

配额管理接口

配额管理接口,用于查询DNS资源配额。

表14 配额管理接口

API

说明

查询租户配额

查询DNS资源配额。

DNSSEC接口

DNSSEC接口,用于开启、关闭、查询DNSSEC。

表15 DNSSEC接口

API

说明

开启DNSSEC

开启公网域名的DNSSEC功能。

关闭DNSSEC

关闭公网域名的DNSSEC功能。

查询DNSSEC

查询公网域名的DNSSEC信息。

终端节点管理接口

终端节点管理接口,包括创建、删除、更新及查询终端节点。

表16 终端节点管理接口

API

说明

创建终端节点

创建终端节点。

查询终端节点列表

查询终端节点列表。

查询终端节点

查询终端节点。

修改终端节点

修改终端节点。

删除终端节点

删除终端节点。

终端节点绑定IP地址

终端节点绑定IP地址。

查询IP地址列表

查询IP地址列表。

终端节点解绑IP地址

终端节点解绑IP地址。

查询终端节点VPC列表

查询终端节点VPC列表。

转发规则管理接口

转发规则管理接口,包括创建、删除、更新及查询转发规则。

表17 转发规则管理接口

API

说明

创建解析器转发规则

创建解析器转发规则。

查询解析器转发规则列表

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

查询解析器转发规则

查询解析器转发规则。

修改解析器转发规则

修改解析器转发规则。

删除解析器转发规则

删除解析器转发规则。

解析器转发规则关联VPC

解析器转发规则关联VPC。

解析器转发规则解关联VPC

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