1 Star 1 Fork 0

chinamobile_ecloud / eloud-sdk-java

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

Java SDK 使用指南

移动云开发者 Java 软件开发工具包(Java SDK)

欢迎使用移动云 Java SDK 。

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

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

使用前提

  • 要使用移动云 Java SDK ,您需要拥有移动云账号以及该账号对应的 Access Key(AK)和 Secret Key(SK)。请在移动云控制台"Access Key管理"页面上创建和查看您的 AK&SK。更多信息请查看 访问密钥
  • 移动云 Java SDK 支持Java JDK 1.8 及其以上版本。

SDK 获取和安装

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

首先您需要在您的操作系统中 下载安装 Maven ,安装完成后您只需在

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

配置移动云镜像:

Maven项目需要在settings.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中心查看

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

代码示例

  • 使用如下代码发起查询系统级标签,首先指定地域(资源池编号)。
  • 调用前请根据实际情况替换如下变量:<YOUR AK><YOUR SK>poolId
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开放平台

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

用户手册

1. 客户端连接参数

1.1 默认配置

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

1.2 超时配置

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

2. 客户端认证信息

认证参数说明

  • ak - 移动云账号 Access Key
  • sk - 移动云账号 Secret Key
  • poolId - 服务部署区域(资源池编号

2.1 使用 AK 和 SK

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

3. 客户端初始化

/**
     * 使用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. 发送请求并查看响应

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进行日志打印,如果在运行代码实例时,未配置日志实现库,会有提示如下:

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

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

logback

<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

<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>
木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

移动云OpenAPI平台的JAVA SDK,可以让JAVA开发者无需关心API请求细节即可快速使用弹性云服务器、虚拟私有云等多个移动云服务。 展开 收起
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/chinamobile_ecloud/eloud-sdk-java.git
git@gitee.com:chinamobile_ecloud/eloud-sdk-java.git
chinamobile_ecloud
eloud-sdk-java
eloud-sdk-java
master

搜索帮助