更新时间:2024-07-25 GMT+08:00

API概览

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

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

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

表1 接口说明

子类型

说明

版本管理

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

公网Zone管理

DNS API的公网域名管理接口,实现对公网域名的创建、删除、修改以及查询。

内网Zone管理

DNS API的内网域名管理接口,实现对内网域名的创建、删除、修改以及查询。

Record Set管理

DNS API的记录集管理接口,实现为公网域名和内网域名创建、删除、修改以及查询解析记录。

Record Set多线路管理

DNS API的多线路解析管理接口,实现为公网域名创建、删除、修改以及查询多线路解析的解析记录。

PTR Record管理

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

TAG管理

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

线路分组管理

DNS API的线路分组管理接口。

自定义线路管理

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

名称服务器管理

DNS API的名称服务器管理接口,实现名称服务器的查询。

配额管理

DNS API的配额管理接口,实现资源配额的查询。

版本管理接口

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

表2 版本管理接口

API

说明

查询所有的云解析服务API版本号

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

查询指定的云解析服务API版本号

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

公网Zone管理接口

公网Zone管理接口,用于创建、查询、删除以及修改公网Zone。

表3 公网Zone管理接口

API

说明

创建单个公网Zone

创建单个公网Zone。

查询单个公网Zone

查询单个公网Zone。

查询公网Zone列表

查询公网Zone列表。

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

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

删除单个公网Zone

删除单个公网Zone。

修改单个公网Zone

修改单个公网Zone。

设置单个公网Zone状态

设置单个公网Zone状态。

内网Zone管理接口

内网Zone管理接口,用于创建、查询、删除以及修改内网Zone。

表4 内网Zone管理接口

API

说明

创建单个内网Zone

创建单个内网Zone。

在内网Zone上关联VPC

为内网Zone关联VPC。

在内网Zone上解关联VPC

为内网Zone解关联VPC。

查询单个内网Zone

查询单个内网Zone。

查询内网Zone列表

查询内网Zone列表。

查询单个内网Zone的名称服务器

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

删除单个内网Zone

删除单个内网Zone。

修改单个内网Zone

修改单个内网Zone。

Record Set管理接口

Record Set管理接口,用于创建、查询、删除以及修改Record Set。

表5 Record Set管理接口

API

说明

创建单个Record Set

创建单个Record Set。

查询单个Record Set

查询单个Record Set。

查询租户Record Set资源列表

查询租户Record Set资源列表。

查询单个Zone下Record Set列表

查询单个Zone的Record Set列表。

删除单个Record Set

删除单个Record Set。

修改单个Record Set

修改单个Record Set。

Record Set多线路管理接口

Record Set多线路管理接口,用于在多线路解析中创建、查询、删除以及修改Record Set。

表6 Record Set多线路管理接口

API

说明

创建单个Record Set

创建单个Record Set,仅适用于公网DNS。

批量删除某个Zone下的Record Set资源

批量删除某个Zone下的Record Set资源。

批量修改RecordSet

批量修改RecordSet。

查询单个Record Set

查询单个Record Set,仅适用于公网DNS。

查询租户Record Set资源列表

查询租户Record Set资源列表。

批量线路创建RecordSet

批量线路创建RecordSet,仅公网Zone支持。

查询单个Zone下Record Set列表

查询单个Zone下Record Set列表。

删除单个Record Set

删除单个Record Set。

修改单个Record Set

修改单个Record Set。

设置Record Set状态

设置Record Set状态。

PTR Record管理接口

PTR Record管理接口,用于为弹性IP设置反向解析,包括设置、查询以及修改Record Set,并支持将弹性IP的PTR Record恢复为默认值。

表7 PTR Record管理接口

API

说明

设置弹性公网IP的PTR记录

设置弹性IP的PTR记录。

查询单个弹性公网IP的PTR记录

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

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

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

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

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

修改弹性公网IP的PTR记录

修改弹性IP的PTR记录。

TAG管理接口

TAG管理接口,用于为资源或实例添加、删除以及查询标签。

表8 TAG管理接口

API

说明

为指定实例添加标签

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

删除资源标签

删除资源标签。

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

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

查询指定实例的标签信息

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

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

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

使用标签查询资源实例

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

线路分组管理接口

表9 线路分组管理接口

API

说明

创建线路分组

创建线路分组。

查询线路分组列表

查询线路分组列表。

查询线路分组

查询线路分组。

更新线路分组

更新线路分组。

删除线路分组

删除线路分组。

自定义线路管理接口

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

表10 自定义线路管理接口

API

说明

创建单个自定义线路

创建单个自定义线路。

查询自定义线路

查询自定义线路。

删除单个自定义线路

删除单个自定义线路。

更新单个自定义线路

更新单个自定义线路。

名称服务器管理接口

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

表11 名称服务器管理接口

API

说明

查询名称服务器列表

查询名称服务器列表。

配额管理接口

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

表12 配额管理接口

API

说明

查询租户配额

查询DNS资源配额。