文档

Python SDK调用示例

更新时间:

使用OpenAPI自动化集成NAT 网关,可以提升您使用NAT 网关的开发效率。本文以Python语言为例,介绍如何使用OpenAPI调用NAT 网关DescribeNatGateways接口查询已创建的NAT网关实例。

步骤一:查看OpenAPI文档

在调用OpenAPI前,建议您先阅读对应接口文档,了解、学习调用该接口所需要的参数及权限等。更多信息,请参见API概览

步骤二:创建RAM用户并授权

重要

阿里云账号拥有所有API的访问权限,建议您创建并使用RAM用户进行API访问或日常运维。

您可以使用阿里云账号(主账号)、RAM用户、RAM角色调用该接口,有关各种身份的差异请参见身份

本示例中,我们使用RAM用户进行接口调用。

  1. 创建RAM用户。

    1. 登录RAM访问控制

    2. 在左侧导航栏,选择身份管理 > 用户

    3. 用户页面,单击创建用户

    4. 创建用户页面,设置登录名称显示名称访问方式控制台访问

    5. 单击确定

      创建RAM用户成功后,请记录用户登录名称和密码,您在调用OpenAPI时,需要使用该RAM用户登录阿里云OpenAPI开发者门户。

  2. 为RAM用户授权。

    1. 访问RAM用户列表

    2. 单击目标RAM用户操作列的添加权限

    3. 在文本框中搜索AliyunNATGateway,选择AliyunNATGatewayFullAccess策略。

      NAT网关权限说明如下,如果您需要新建自定义权限,请参见授权信息

      • AliyunNATGatewayReadOnlyAccess:只读访问NAT 网关的权限。

      • AliyunNATGatewayFullAccess:管理NAT 网关的权限。

    4. 单击确定,完成授权操作。

  3. 进入到对应的RAM用户详情页,在认证管理页签,点击创建 AccessKey

    更多操作详情,请参见创建AccessKey

    重要

    RAM用户的AccessKey Secret只在创建时显示,不支持查看,请下载CSV文件后妥善保管。

步骤三:准备环境

  1. 下载并安装Python。

    具体操作,请参见安装Python

  2. 搭建Python开发环境。

    本文以在Windows安装PyCharm为例。具体操作,请参见在Windows搭建Python开发环境

  3. 配置环境变量。

    调用接口前,需要配置环境变量,以便通过环境变量读取访问凭证。在Linux、macOS和Windows操作系统下配置环境变量的方法,请参见在Linux、macOS和Windows系统配置环境变量

    重要

    环境变量配置完成之后,为确保新的设置被正确应用,您可能需要重启相关的开发工具(IDE等)或服务。

  4. 安装环境依赖。

    在终端设备中,执行以下命令,安装NAT网关的SDK包与环境依赖。

    pip install alibabacloud_vpc20160428==6.7.0
    pip install alibabacloud_tea_console

步骤四:在线调试OpenAPI

  1. 使用RAM用户登录OpenAPI门户的API调试页面。

  2. 选择云产品为专有网络

  3. 在左侧导航栏,找到并单击DescribeNatGateways接口,服务地址选择华北1(青岛)NatGatewayId参数输入ngw-m5etniqz69hcgmfzt****

  4. 单击发起调用

    调用结果区域,您可以看到查询结果、Request Header、Response Header等信息,状态码200表示调用成功。

    门户调用

步骤五:获取SDK示例代码

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

以获取Python SDK示例代码为例,其他语言获取方式相同。

  1. SDK示例页签,选择SDK版本和SDK语言。推荐使用V2.0版本。关于V2.0和V1.0的区别,请参见V1.0 SDK和V2.0 SDK区别

  2. 单击下载完整工程可以下载完整的SDK工程。下载完后完成解压。

    说明
    • 在SDK示例显示区域的右上角,单击image图标可以复制SDK示例代码。

    • 单击SDK信息,可以获取SDK包名称、SDK包版本、SDK包管理平台、SDK安装命令等基础信息,便于您集成开发。

    示例代码

步骤六:运行SDK示例代码

以运行Python SDK示例代码为例。

  1. 打开PyCharm,单击File > Open,选择解压好的工程文件,在Creating Virtual Environment窗口单击OK,等待Python虚拟环境的创建和依赖资源下载。

  2. 运行示例代码

    在PyCharm窗口顶部,单击运行按钮,运行代码。

    2711460A-C58C-44a3-8C75-4B52051C3C0A

  3. 查看运行结果。在底部控制台按下ctrl+f,搜索statusCode,如果看到"statusCode":200表示调用成功。

    6AEF4060-9D4E-47a2-A33E-FC7BBFB72DAB

相关文档