文档

Java SDK使用示例

更新时间:

本文介绍如何在阿里云OpenAPI开发者门户调用API获取并使用Java SDK示例代码。

前提条件

  • 已下载并安装JDK 1.8或更高版本,并已经配置Java环境变量。

  • 已下载并安装Java开发工具。

    本文以IntelliJ IDEA为例。

  • 已获取访问密钥AccessKey。

    在调用阿里云API时您需要使用AccessKey完成身份验证。AccessKey包括AccessKey ID和AccessKey Secret。关于如何创建和获取AccessKey,请参见创建AccessKey

操作步骤

步骤一:下载SDK完整工程

  1. 进入OpenAPI门户的API调试页面,在左侧选择API接口。

    本示例以DescribeSourceServers接口为例。

  2. 在左侧的参数配置页签,选择服务地址,并填写需要的参数信息。填写时请参考右侧的文档页签,充分了解接口的说明和注意事项(尤其是费用相关信息),以及各参数的具体含义和使用方法。

  3. 在右侧的SDK示例页签,选择Java语言,单击下载完整工程按钮,下载SDK完整工程至本地并解压。

    说明

    image.png

步骤二:导入解压后的工程

  1. 打开开发者工具IDEA。

  2. 在顶部菜单中,选择File > New > Project from Existing Sources...

    image.png

  3. 在弹出的对话框中,选择解压后的SDK完整工程文件。

步骤三:配置身份验证

通过阿里云提供的Credentials工具,配置访问接口时的身份验证。阿里云SDK支持通过定义ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET环境变量来创建默认的访问凭证。调用接口时,程序直接访问凭证,读取您的访问密钥(即AccessKey)并自动完成鉴权。

阿里云Credentials工具提供多种身份验证配置方案,更多信息,请参见身份验证配置

  1. pom.xml文件中,添加以下依赖,安装阿里云SDK Credentials工具。

    说明

    阿里云SDK Credentials工具的版本会持续更新,建议您可以访问版本更新日志获取最新版本。

    <dependency>
        <groupId>com.aliyun</groupId>
        <artifactId>credentials-java</artifactId>
        <version>0.2.11</version>
    </dependency>

    image.png

  2. 右键单击pom.xml文件,选择Maven > Reload project,Maven项目管理工具会自动下载相关的jar包。

  3. 配置环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET。具体操作,请参见在Linux、macOS和Windows系统配置环境变量

    说明

    创建和获取AccessKey的具体操作,请参见创建AccessKey

步骤四:运行SDK示例代码

  1. 在IDEA左侧导航栏中,打开Java SDK示例代码文件。

  2. 在顶部菜单中,选择Run > Run...运行代码。

    image.png

  3. 查看代码运行结果。

    image.png

后续您可以根据需要对SDK配置HTTPS请求、代理、超时和重试机制等,具体操作,请参见进阶配置

  • 本页导读 (1)