文档

API概览

更新时间:
本产品(云解析 PrivateZone/2018-01-01)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

公共

API标题API概述
DescribeUserServiceStatus查询当前用户的服务状态查询当前用户的服务状态,例如是否开通服务,是否欠费等。
SetProxyPattern设置递归解析代理调用SetProxyPattern设置子域名递归解析代理。
DescribeChangeLogs获取操作日志调用DescribeChangeLogs接口获取内网DNS解析操作日志。操作日志是记录内置权威、缓存管理、转发管理、服务地址以及查询解析记录的操作日志,可以根据行为、内容等关键字进行模糊查询。
DescribeRegions获取Region列表调用DescribeRegions接口获取可用地域列表供用户选择,可根据场景信息、vpc类型等进行筛选。
MoveResourceGroup更换资源组调用MoveResourceGroup接口更换资源组。

Zone

API标题API概述
AddZone添加zone调用AddZone创建内置权威域名,内置权威域名可以添加在普通区或加速区。
DeleteZone删除zone调用DeleteZone删除一个空闲的内置权威域名(Zone)。
UpdateZoneRemark修改zone的备注信息调用UpdateZoneRemark修改内置权威域名(zone)的备注信息。
DescribeZoneInfo获取zone详细信息调用DescribeZoneInfo获取指定内置权威域名(Zone)的详细信息,包括当前Zone绑定的Vpc列表信息等。
DescribeZones获取 zone 列表调用DescribeZones查询当前用户的Zone列表。
DescribeZoneVpcTree获取 Zone 列表和绑定的 VPC调用DescribeZoneVpcTree获取当前账号下Zone 列表及其绑定的 VPC 列表。
BindZoneVpczone关联VPC绑定或者解绑zone与VPC列表两者之间的关系,设置域名(zone)生效范围。
CheckZoneName根据规则校验zone是否可添加调用CheckZoneName根据规则校验zone名称是否可添加。

标签

API标题API概述
DescribeTags查询已有的标签列表调用DescribeTags查询内网DNS解析(PrivateZone)资源的标签列表。
ListTagResources查询资源标签关系列表调用ListTagResources查询内网DNS解析(PrivateZone)资源标签关系列表。
TagResources标记资源调用TagResources标记内网DNS解析(PrivateZone)资源,批量增加或修改资源Zone的标签信息。
UntagResources取消标记资源调用UntagResources取消内网DNS解析(PrivateZone)标记资源,批量删除Zone标签信息。

数据

API标题API概述
DescribeRequestGraph获取请求量详情调用DescribeRequestGraph,根据时间范围等条件查询请求量详情。
DescribeStatisticSummary获取昨日请求量概要调用DescribeStatisticSummary获取昨请求量概要,包括Zone请求量Top3信息和vpc请求量Top3信息。

解析记录

API标题API概述
AddZoneRecord添加解析记录调用AddZoneRecord添加内置权威解析记录。在解析生效范围内,该域名的内网解析记录会覆盖其公网解析记录。
DeleteZoneRecord删除解析记录调用DeleteZoneRecord根据解析记录ID删除解析记录。
SetZoneRecordStatus设置解析记录状态调用SetZoneRecordStatus设置域名(Zone)析记录状态,启用或暂停解析。
UpdateRecordRemark更新解析记录备注调用UpdateRecordRemark根据解析记录ID修改解析记录的备注信息。
UpdateZoneRecord修改解析记录调用UpdateZoneRecord修改域名(Zone)的解析记录,包括主机记录、解析记录、权重等。
DescribeZoneRecords查询解析记录列表调用DescribeZoneRecords查询域名解析记录列表。

转发管理

API标题API概述
AddResolverEndpoint新增终端节点调用AddResolverEndpoint新增终端节点。
AddResolverRule新增转发规则调用AddResolverRule新增转发规则。
BindResolverRuleVpc转发规则关联VPC调用BindResolverRuleVpc设置转发规则关联VPC。
DeleteResolverEndpoint删除终端节点调用DeleteResolverEndpoint根据终端节点ID删除终端节点。
DeleteResolverRule删除转发规则调用DeleteResolverRule根据转发规则ID删除转发规则。
DescribeResolverEndpoint获取终端节点详情调用DescribeResolverEndpoint根据终端节点ID获取终端节点详情。
DescribeResolverEndpoints获取终端节点列表调用DescribeResolverEndpoints获取终端节点列表。
DescribeResolverRule获取转发规则详情调用DescribeResolverRule根据转发规则ID获取转发规则详情。
DescribeResolverRules获取转发规则列表获取转发规则列表。
UpdateResolverEndpoint修改终端节点调用UpdateResolverEndpoint修改终端节点。
UpdateResolverRule修改转发规则调用UpdateResolverRule修改转发规则。
DescribeResolverAvailableZones获取可用区域列表调用DescribeResolverAvailableZones获取可用区域列表。

跨账号授权

API标题API概述
AddUserVpcAuthorization新增跨账号VPC授权添加跨账号VPC授权。
DescribeUserVpcAuthorizations获取跨账号授权列表调用DescribeUserVpcAuthorizations获取跨账号授权列表。
DeleteUserVpcAuthorization删除跨账号授权调用DeleteUserVpcAuthorization删除跨账号授权,可以根据账号ID和授权类型删除。

主机名同步

API标题API概述
UpdateSyncEcsHostTask更新主机名同步任务调用UpdateSyncEcsHostTask新增或更新主机名同步任务。
DescribeSyncEcsHostTask获取主机名同步任务详情调用DescribeSyncEcsHostTask根据域名ID获取主机名同步任务详情。

其他

API标题API概述
UpdateCustomLine修改自定义线路修改自定义线路
DescribeCustomLineInfo查询自定义线路详细信息查询自定义线路详细信息。
DeleteCustomLine删除自定义线路删除自定义线路。
AddCustomLine添加自定义线路创建自定义线路。
SearchCustomLines搜索自定义线路搜索自定义线路。
DescribeCustomLines查询自定义线路列表查询自定义线路列表。
ChangeZoneDnsGroup修改ZONE的位置区修改ZONE的位置区。
DescribeZoneRecord查询解析记录详情查询解析记录详情。