集成概览

本文为您介绍使用NAT 网关OpenAPI的基本信息,包括版本说明、接入点说明、接口风格和调用方式支持情况。

说明

NAT 网关专有网络 VPC使用同一个服务地址(Endpoint)。

OpenAPI介绍

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

版本说明

阿里云OpenAPI通过版本号管控各时期云产品大版本的API列表,例如NAT 网关目前支持2016-04-28版本的API列表,2016-04-28代表的是API版本号而非时间概念,所展示的都是最新的API公开数据,并非自2016-04-28之后就未更新。

版本号

说明

2016-04-28

推荐使用。

在线调试

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

调试入口

调试API入口为:NAT网关调试入口

接入点说明

NAT 网关OpenAPI支持多接入点。更多信息,请参见服务接入点

支持的用户身份

您阿里云账号登录OpenAPI网站后,OpenAPI默认使用您的阿里云账号进行在线OpenAPI调试。阿里云账号拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。请根据业务的实际情况按需分配权限后进行接口调用。RAM用户需具备操作NAT资源的权限。具体操作,请参见使用RAM进行访问控制

用户身份

支持情况

阿里云账号

支持

RAM用户(推荐)

支持

RAM角色(推荐)

支持

更多信息

您可以通过以下文档了解更多关于阿里云OpenAPI的身份、凭据、授权、流量控制以及配额的相关内容。

集成方式

说明

SDK是最易于集成,且支持度最好的OpenAPI调用方式,推荐您选择使用SDK。

集成方式

支持情况

阿里云SDK

支持

阿里云CLI

支持

资源编排

支持

Terraform

支持

  • 阿里云SDK

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

    • 支持在OpenAPI通过阿里云SDK调用。支持语言及依赖的安装方法请参见专有网络SDK

  • 阿里云CLI

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

  • Terraform

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

    • 支持Terraform编排和使用NAT网关资源,支持部分普通资源和数据资源清单,请参见NAT Gateway资源和数据源

  • 资源编排ROS

  • 自定义封装API调用

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

注意事项

  • 如果调用API后返回错误,您需要根据返回的错误码提示检查传入的请求参数及其取值是否正确。

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