简介
欢迎使用阿里云开发者工具套件(SDK)。阿里云Java SDK让您不用复杂编程即可访问云服务器、云监控等多个阿里云服务。这里向您介绍如何获取阿里云Java SDK并开始调用。
环境准备
阿里云Java SDK适用于JDK 6及以上版本。
要使用阿里云Java SDK,您需要一个云账号以及一对Access Key ID和Access Key Secret。 请在阿里云控制台中的AccessKey管理页面上创建和查看您的Access Key,或者联系您的系统管理员。
要使用阿里云SDK访问某个产品的API,您需要事先在阿里云控制台中开通这个产品。
SDK获取和安装
阿里云Java SDK发布在
https://develop.aliyun.com/tools/sdk#/java 这个地址。
请注意,部分阿里云产品的SDK未收录到这个列表中,例如对象存储(OSS),表格存储(Table Store),请前往这些产品的详情页获取相应的SDK。
要成功地调用一个产品的SDK,
您至少需要首先安装SDK核心库。 例如,对云服务器SDK的调用,您需要获取和安装2个SDK,分别是SDK核心库和云服务器的SDK。
您可以通过以下两种方式来安装SDK:在Maven项目中加入依赖项,和在集成开发环境(IDE)中导入Jar包。
方式一: Maven项目中加入依赖项(推荐)
如果您使用Maven来管理您的Java项目,要获得阿里云Java SDK,只需在pom.xml里加入相应的依赖项即可。这些依赖项可以在阿里云Java SDK的
发布地址中找到。
以3.2.2版本的SDK核心库和3.0.0版本的云服务器SDK为例:
- <dependency>
- <groupId>com.aliyun</groupId>
- <artifactId>aliyun-java-sdk-core</artifactId>
- <version>3.2.2</version>
- </dependency>
- <dependency>
- <groupId>com.aliyun</groupId>
- <artifactId>aliyun-java-sdk-ecs</artifactId>
- <version>3.0.0</version>
- </dependency>
方式二:在集成开发环境(IDE)中导入JAR包
不论您使用了Eclipse还是IntelliJ作为集成开发环境,您都可以通过导入JAR包的方式来获取阿里云Java SDK。这些JAR包可以在阿里云Java SDK的
发布地址中下载。
Eclipse
将下载的 aliyun-java-sdk-XXX.jar 文件复制到您的项目文件夹中。
在Eclipse中,依次选择菜单:工程,Properties,Java Build Path, Add JARs。
选中您下载的这些JAR文件。
IntelliJ
将下载的 aliyun-java-sdk-XXX.jar 文件复制到您的项目文件夹中。
在IntelliJ中,依次选择菜单:File, Project Structure, Modules, 然后选择 Dependencies 选项卡。在出现的列表中选择“添加”(对话框右方的绿色“+”号),再选择 “JARs or directories”。
选中您下载的这些JAR文件。
开始调用
以下这个代码示例向您展示了调用阿里云SDK的3个主要步骤:
- 创建DefaultAcsClient实例并初始化
- 创建API请求并设置参数
- 发起请求并处理异常
- import com.aliyuncs.profile.DefaultProfile;
- import com.aliyuncs.DefaultAcsClient;
- import com.aliyuncs.IAcsClient;
- import com.aliyuncs.exceptions.ClientException;
- import com.aliyuncs.exceptions.ServerException;
- import com.aliyuncs.ecs.model.v20140526.*;
- class Sample {
- public static void main(String[] args) {
- // 创建DefaultAcsClient实例并初始化
- DefaultProfile profile = DefaultProfile.getProfile(
- "<your-region-id>", // 您的可用区ID
- "<your-access-key-id>", // 您的Access Key ID
- "<your-access-key-secret>"); // 您的Access Key Secret
- IAcsClient client = new DefaultAcsClient(profile);
- // 创建API请求并设置参数
- DescribeInstancesRequest request = new DescribeInstancesRequest();
- request.setPageSize(10);
- // 发起请求并处理异常
- try {
- DescribeInstancesResponse response = client.getAcsResponse(request);
- } catch (ServerException e) {
- e.printStackTrace();
- } catch (ClientException e) {
- e.printStackTrace();
- }
- }
- }
在创建DefaultAcsClient实例并初始化时,您需要填写3个参数:Region ID、Access Key ID和Access Key Secret。Access Key ID和Access Key Secret可以从控制台获得;而Region ID可以从
地域列表中获得。
API参考
要知道您想访问的产品提供的API以及它们的参数,请参考
开放了API的产品列表。