文档

集成概览

更新时间:

内网DNS解析(PrivateZone)提供可视化操作控制台,还提供OpenAPI在线调试、阿里云SDK、阿里云CLI等调用方式。本文为您介绍内网DNS解析(PrivateZone)开放的OpenAPI及支持的集成方式,为了提升您使用DNS的开发效率,建议您按需选择合适的操作和集成方式。

OpenAPI介绍

为了能够让开发者快速高效的学习和使用云产品OpenAPI,阿里云为用户提供OpenAPI网站。它是一款集OpenAPI智能搜索、文档、在线调试、SDK获取、CodeSample、调用出错诊断、调用统计为一体的产品。您可以在OpenAPI门户中调用阿里云各云产品开放的OpenAPI,查看OpenAPI请求和返回结果。此外,OpenAPI门户会自动生成相应的SDK调用示例,帮助您快速使用阿里云产品。更多信息,请参见什么是OpenAPI

版本说明

阿里云OpenAPI通过版本号管控各时期云产品大版本的API列表,例如内网DNS解析(PrivateZone)目前支持2018-01-01版本的API列表,2018-01-01代表的是API版本号而非时间概念,所展示的都是最新的API公开数据,并非自2018-01-01之后就未更新。

版本号

说明

2018-01-01

推荐使用

在线调试

内网DNS解析(PrivateZone)在OpenAPI门户提供API调试等功能。在调用前,您需要了解内网DNS解析(PrivateZone)提供的版本、接入点说明、集成方式等信息。

image

调试入口

调试API入口为:内网DNS解析(PrivateZone)调试列表

接入点说明

根据相关资源所在地域,选择对应的服务接入点地址,以获得最低延迟。内网DNS解析(PrivateZone)全局公网接入地址为pvtz.aliyuncs.com,全局VPC接入地址为pvtz.vpc-proxy.aliyuncs.com

  • 公网接入地址在全球都可访问。

  • VPC接入地址只有在阿里云对应的地域内,且是VPC网络类型才可访问。VPC地址的优势:

    • 高安全性:VPC服务地址只能在VPC内部访问,提供更高的安全性和隐私性。

    • 更快的响应速度:由于VPC服务地址在VPC内部网络中运行,其响应速度通常比公网服务更快,且可以避免公网延迟和带宽限制等问题。

    • 更低的成本:VPC服务地址可以使用内部网络通信。

更多信息,请参见服务接入点

用户身份

内网DNS解析(PrivateZone)支持通过如下用户身份调用OpenAPI。推荐您使用RAM用户RAM角色,根据业务的实际情况按需分配权限后进行接口调用。

用户身份

支持情况

阿里云账号

支持

RAM 用户(推荐)

支持

RAM角色(推荐)

支持

推荐您使用RAM用户RAM角色,根据业务实际情况按需分配权限后进行接口调用。

更多信息

集成方式

说明

内网DNS解析 (PrivateZone)提供SDK、CLI等多种集成方式,您可以根据业务的实际需要进行选择

集成方式总览

调用方式

支持情况

阿里云SDK(推荐)

支持

阿里云CLI

支持

Terraform

支持

资源编排ROS

不支持

自定义封装API调用

支持

推荐您使用RAM用户RAM角色,根据业务实际情况按需分配权限后进行接口调用。

阿里云SDK

  • 阿里云为开发者提供了多种编程语言(Java、C#、Go、Python、Node.js/TypeScript、PHP、C++等)的SDK。开发者只需集成SDK,通过SDK暴露的方法直接调用OpenAPI。SDK统一封装了签名逻辑、超时机制、重试机制,并根据文档返回结构化Response对象,易于开发。更多关于阿里云SDK的介绍,请参见阿里云SDK

  • 内网DNS解析(PrivateZone)服务SDK支持的语言及依赖安装方法请参见内网DNS解析(PrivateZone)服务SDK参考

  • 内网DNS解析 (PrivateZone)服务SDK支持的语言及依赖安装方法,请参见SDK参考

阿里云CLI

  • 阿里云命令行工具可以帮助您在使用命令行终端时,通过aliyun命令与阿里云服务进行交互,管理云服务资源。有关阿里云CLI的更多详细信息,请参见什么是阿里云CLI

  • 快速使用CLI集成内网DNS解析(PrivateZone),请参见CLI集成示例

Terraform

  • Terraform 是一种开源工具,用于安全高效地预览,配置和管理云基础架构和资源。它与阿里云的资源编排服务的运行机制类似,通过将模板转化为内部数据后完成 OpenAPI 调用。更多详情,请参见什么是Terraform

  • 支持Terraform编排和使用内网DNS解析(PrivateZone),支持部分普通资源和数据资源清单,请参见内网DNS解析(PrivateZone)资源和数据源

  • 快速使用Terraform集成内网DNS解析(PrivateZone),请参见Terraform集成示例

资源编排ROS

  • 资源编排服务ROS(Resource Orchestration Service)是阿里云提供的一项简化云计算资源管理的服务。开发者和管理员可以编写模板,在模板中定义所需的阿里云资源(例如:ECS 实例、RDS 数据库实例)、资源间的依赖关系等。ROS 的编排引擎将根据模板自动完成所有资源的创建和配置,实现自动化部署及运维。更多详情,请参见什么是资源编排服务

  • 暂不支持使用资源编排ROS调用内网DNS解析(PrivateZone)服务。

自定义封装API调用

原生HTTP调用需要您自己实现签名算法,并构建自定义请求,发起HTTP调用。有关签名机制的更多详细信息,请参见API概览V3版本请求体&签名机制

注意事项

如果调用内网DNS解析(PrivateZone)API后返回错误,您需要根据返回的错误码提示检查传入的请求参数及其取值是否正确。更多信息,请参见公共错误码

您也可以记录下调用返回的RequestID或SDK报错信息,通过阿里云OpenAPI诊断平台进行自助诊断。