本产品(
云解析 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 列表。 |
BindZoneVpc | zone关联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 | 查询解析记录详情 | 查询解析记录详情。 |