Skip to content

Latest commit

 

History

History
150 lines (114 loc) · 6.04 KB

README-CN.md

File metadata and controls

150 lines (114 loc) · 6.04 KB
Raw

English | 简体中文

alibaba cloud logo

Alibaba Cloud SDK for Java

Maven Central Version Java CI with Maven codecov

欢迎使用 Alibaba Cloud SDK for Java 。Alibaba Cloud SDK for Java 让您不用复杂编程即可访问云服务器、云监控等多个阿里云服务。 这里向您介绍如何获取 Alibaba Cloud SDK for Java 并开始调用。 如果您在使用 Alibaba Cloud SDK for Java 的过程中遇到任何问题，欢迎在当前 GitHub 提交 Issues。

环境要求

  1. 要使用 Alibaba Cloud SDK for Java ，您需要一个云账号以及一对Access Key ID和Access Key Secret。 请在阿里云控制台中的RAM管理页面上创建和查看您的Access Key，或者联系您的系统管理员。
  2. 要使用 Alibaba Cloud SDK for Java 访问某个产品的API，您需要事先在阿里云控制台中开通这个产品。
  3. Alibaba Cloud SDK for Java 需要 1.8 以上的 JDK。

安装依赖

无论您要使用哪个产品的开发工具包，都必须安装aliyun-java-sdk-core。比如，对云服务器SDK的调用，您需要安装aliyun-java-sdk-core和aliyun-java-sdk-ecs。

通过Maven来管理项目依赖(推荐)

如果您使用Apache Maven来管理Java项目，只需在项目的pom.xml文件加入相应的依赖项即可。您可以在阿里云SDK中心中查看各云产品的Maven依赖。 以使用Ecs SDK为例，您只需在pom.xml中声明以下两个依赖：

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-core</artifactId>
    <version>[4.6.3,5.0.0)</version>
</dependency>
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-ecs</artifactId>
    <version>[4.16.0,5.0.0)</version>
</dependency>

如果 maven 没有从中央存储库下载 jar 包，则需要将这些依赖项添加到pom.xml文件中，否则将报告 NoClassDefFoundError 异常

<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.10.1</version>
</dependency>
<dependency>
    <groupId>io.opentracing</groupId>
    <artifactId>opentracing-api</artifactId>
    <version>0.33.0</version>
</dependency>
<dependency>
    <groupId>io.opentracing</groupId>
    <artifactId>opentracing-util</artifactId>
    <version>0.33.0</version>
</dependency>

使用诊断

Troubleshoot 提供 OpenAPI 使用诊断服务，通过 RequestID 或 报错信息 ，帮助开发者快速定位，为开发者提供解决方案。

快速使用

以下这个代码示例向您展示了如何调用 Alibaba Cloud SDK for Java：

package com.testprogram;

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.*;

public class Main {
    public static void main(String[] args) {
        // 1. 创建DefaultAcsClient实例并初始化。
        DefaultProfile profile = DefaultProfile.getProfile(
            "<your-region-id>",          // 地域ID
            "<your-access-key-id>",      // RAM账号的AccessKey ID
            "<your-access-key-secret>"); // RAM账号Access Key Secret
        IAcsClient client = new DefaultAcsClient(profile);

        // 2. 创建API请求并设置参数
        DescribeInstancesRequest request = new DescribeInstancesRequest();
        request.setPageSize(10);

        // 3. 发起请求并处理应答或异常
        DescribeInstancesResponse response;
        try {
            response = client.getAcsResponse(request);
            for (DescribeInstancesResponse.Instance instance:response.getInstances()) {
                System.out.println(instance.getPublicIpAddress());
            }
        } catch (ServerException e) {
            e.printStackTrace();
         } catch (ClientException e) {
            e.printStackTrace();
        }
    }
}

因为安全的原因，我们不推荐在源代码中硬编码凭证信息。你应该通过外部配置或者环境变量的方式来访问凭证信息。

文档

问题

提交 Issue，不符合指南的问题可能会立即关闭。

发行说明

每个版本的详细更改记录在发行说明中。

贡献

提交 Pull Request 之前请阅读贡献指南。

相关

许可证

Apache-2.0

Copyright (c) 2009-present, Alibaba Cloud All rights reserved.