# eloud-sdk-java

**Repository Path**: chinamobile_ecloud/eloud-sdk-java

## Basic Information

- **Project Name**: eloud-sdk-java
- **Description**: 移动云OpenAPI平台的JAVA SDK，可以让JAVA开发者无需关心API请求细节即可快速使用弹性云服务器、虚拟私有云等多个移动云服务。
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: https://ecloud.10086.cn/op-oneapi-static/#/openapi
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2023-11-02
- **Last Updated**: 2025-03-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Java SDK 使用指南
移动云开发者 Java 软件开发工具包（Java SDK）
=============================

欢迎使用移动云 Java SDK 。

移动云 Java SDK 让您无需关心请求细节即可快速使用标签管理等多个移动云服务。

这里将向您介绍如何获取并使用移动云 Java SDK 。

使用前提
----

* 要使用移动云 Java SDK ，您需要拥有移动云账号以及该账号对应的 Access Key（AK）和 Secret Key（SK）。请在移动云控制台"Access Key管理"页面上创建和查看您的 AK\&SK。更多信息请查看 [访问密钥](https://ecloud.10086.cn/op-help-center/doc/article/49739) 。
* 移动云 Java SDK 支持**Java JDK 1.8** 及其以上版本。

SDK 获取和安装
---------

推荐您通过 Maven 安装依赖的方式使用移动云 Java SDK：

首先您需要在您的操作系统中 [下载](https://maven.apache.org/download.cgi) 并 [安装](https://maven.apache.org/install.html) Maven ，安装完成后您只需在

Maven 项目的 `pom.xml` 文件加入相应的依赖项即可。

### 配置移动云镜像：

Maven项目需要在settings.xml文件中设置移动云镜像仓库地址 ：

```xml
<mirror>
     <id>nexus-ecloud</id>
     <mirrorOf>*</mirrorOf>
     <name>Nexus ecloud</name>
     <url>https://ecloud.10086.cn/api/query/developer/nexus/repository/eCloudSDK/</url>
</mirror>
```

### 独立服务包：

根据需要独立引入SDK依赖包 。以使用标签管理TAG SDK 为例，您需要安装 `ecloud-sdk-tag` ：
> 注：各产品SDK最新版本请至[SDK中心](https://ecloud.10086.cn/op-oneapi-static/#/center/sdk)查看

```xml
<dependency>
   <groupId>com.ecloud.sdk</groupId>
   <artifactId>ecloud-sdk-tag</artifactId>
   <version>1.0.18</version>
</dependency>
```

代码示例
----

* 使用如下代码发起查询系统级标签，首先指定地域（[资源池编号](https://ecloud.10086.cn/op-help-center/doc/article/54462)）。
* 调用前请根据实际情况替换如下变量：`<YOUR AK>`、`<YOUR SK>`、`poolId` 。

```java
package com.ecloud.sdk.tag.v1;

import com.ecloud.sdk.ApiException;
import com.ecloud.sdk.JSON;
import com.ecloud.sdk.config.Config;
import com.ecloud.sdk.tag.v1.Client;
import com.ecloud.sdk.tag.v1.model.*;
import java.util.*;

public class QuerySystemTagListSample {
  /**
   * 使用AK&SK初始化账号Client
   *
   * @param accessKey
   * @param secretKey
   * @param poolId
   * @return Client
   */
  private static Client createClient(String accessKey, String secretKey, String poolId) {
    Config config = new Config();
    config.setAccessKey(accessKey);
    config.setSecretKey(secretKey);
    config.setPoolId(poolId);
    return new Client(config);
  }

  public static void main(String[] args) throws ApiException {
    Client client = QuerySystemTagListSample.createClient("<YOUR AK>", "<YOUR SK>", "poolId");
    QuerySystemTagListRequest querySystemTagListRequest = new QuerySystemTagListRequest();
    QuerySystemTagListResponse result = client.querySystemTagList(querySystemTagListRequest);
    System.out.println(new JSON().getGson().toJson(result));
  }
}
```

在线调试
----

[API开放平台](https://ecloud.10086.cn/op-oneapi-static/#/overview)

提供API检索及平台调试，支持全量快速检索、可视化调试、帮助文档查看等能力。

用户手册
----

### 1. 客户端连接参数

#### 1.1 默认配置

```java
// 使用默认配置
Config config = new Config();
Client client = new Client(config);
```

#### 1.2 超时配置

```java
// 默认连接超时时间为60秒，可根据需要调整
config.setConnectTimeout(10);
// 默认响应超时时间为120秒，可根据需要调整
config.setReadTimeout(10);
```

### 2. 客户端认证信息

**认证参数说明** ：

* `ak` - 移动云账号 Access Key
* `sk` - 移动云账号 Secret Key
* `poolId` - 服务部署区域（[资源池编号](https://ecloud.10086.cn/op-help-center/doc/article/54462)）

#### 2.1 使用 AK 和 SK

```java
config.setAccessKey(accessKey);
config.setSecretKey(secretKey);
config.setPoolId(poolId);
```

### 3. 客户端初始化

```java
/**
     * 使用AK&SK初始化账号Client
     *
     * @param accessKey
     * @param secretKey
     * @param poolId
     * @return Client
    */
    private static Client createClient(String accessKey, String secretKey, String poolId)    {
        Config config = new Config();
        config.setAccessKey(accessKey);
        config.setSecretKey(secretKey);
        config.setPoolId(poolId);
        return new Client(config);
}
```

### 4. 发送请求并查看响应

```java
Client client = QuerySystemTagListSample.createClient("<YOUR AK>", "<YOUR SK>", "poolId");
QuerySystemTagListRequest querySystemTagListRequest = new QuerySystemTagListRequest();
QuerySystemTagListResponse result = client.querySystemTagList(querySystemTagListRequest);
System.out.println(new JSON().getGson().toJson(result));
```

### 5 故障处理

SDK 提供 Access 级别的访问日志及 Debug 级别的原始 HTTP 监听器日志，用户可根据需要进行配置。

#### 5.1 访问日志

**注意：** SDK在运行的时候默认采用slf4j进行日志打印，如果在运行代码实例时，未配置日志实现库，会有提示如下：

```text
SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
```

所以需要用户根据目标项目实际情况引入对应的日志实现，请在对应的工程项目的 pom.xml 文件中引入日志实现的依赖，如：

**slf4j**

```xml
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-simple</artifactId>
    <version>1.7.21</version>
</dependency>
```

**logback**

```xml
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
</dependency>
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
    <version>1.2.3</version>
</dependency>
```

**log4j**

```xml
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>
```