1 Star 7 Fork 1

chinamobile_ecloud / ecloud-sdk-cpp

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

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

欢迎使用移动云C++ SDK 。

移动云 C++ SDK 让您无需关心请求细节即可快速使用弹性云主机等多个移动云服务。

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

使用前提

  • 要使用移动云 C++ SDK ,您需要拥有移动云账号以及该账号对应的 Access Key(AK)和 Secret Key(SK)。请在移动云控制台 “我的凭证-访问密钥” 页面上创建和查看您的 AK&SK 。更多信息请查看 访问密钥

  • 移动云 C++ SDK 支持 C++ 11 及以上版本,要求安装CMake 3.10及以上版本。

SDK 获取和安装

依赖的第三方库

boostcpprestsdkspdlogopenssl

Linux安装SDK

1、安装依赖包

所需依赖包除spdlog外都可以在各系统包管理工具中获取:

例如基于 Debian/Ubuntu 的系统

sudo apt-get install libboost-all-dev libssl-dev libcpprest-dev

基于 CentOS 的系统

sudo yum install libboost-all-dev libssl-dev libcpprest-dev

spdlog手动编译安装:

git clone https://github.com/gabime/spdlog.git
cd spdlog && mkdir build && cd build
cmake .. && make -j

spdlog安装,请参考:gabime/spdlog官方说明

2、安装SDK包

git clone https://gitee.com/chinamobile_ecloud/ecloud-sdk-cpp.git
cd ecloud-sdk-cpp
mkdir build
cd build && cmake ..
make && make install

完成上述操作后,C++ SDK 安装目录为 /usr/local

Windows安装SDK

推荐使用vcpkg管理第三方依赖包,Windows操作系统安装vcpkg,请参考:

microsoft/vcpkg官方说明

1、安装依赖包

vcpkg install cpprestsdk boost openssl spdlog

2、使用 CLion 进行编译

2.1、使用 CLion 打开 ecloud-sdk-cpp 目录

2.2、选择 FileSettings

2.3、选择 Build, Execution, DeploymentCMake

2.4、在 CMake options 中加入

2.5、-DCMAKE_TOOLCHAIN_FILE={your vcpkg install dir}/scripts/buildsystems/vcpkg.cmake

2.6、右键 CMakeLists.txt 选择 Load CMake Project

2.7、选择Build开始编译

3、安装C++ SDK

编译完成后选择 BuildInstall

完成上述操作后,C++ SDK 安装目录为 C:\Program File (x86)\ecloud-sdk-cpp

代码示例

  • 使用如下代码查看绑定的虚拟网卡列表,首先指定地域(资源池编号)。
  • 调用前请根据实际情况替换如下变量: <YOUR AK><YOUR SK>poolId
#include <string>
#include <memory>
#include <vector>

#include <ecloud/core/Config.h>
#include <ecloud/ecs/v1/Client.h>
using namespace Ecloud::Sdk::ECS::V1;
using namespace Ecloud::Sdk::ECS::V1::Model;
using namespace Ecloud::Sdk::Core;
using namespace std;

int main(void)
{
    auto config = std::make_shared<Config>();
    config->setAccessKey("<YOUR AK>");
    config->setSecretKey("<YOUR SK>");
    config->setPoolId("poolId");
    auto client = std::make_shared<Client>(config);
    VmGetServerPortsRequest vmGetServerPortsRequest;
    VmGetServerPortsPath vmGetServerPortsPath;
    vmGetServerPortsPath.setServerId("test001");
    vmGetServerPortsRequest.setVmGetServerPortsPath(vmGetServerPortsPath);
    auto result = client->vmGetServerPorts(vmGetServerPortsRequest);
}

在线调试

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

用户手册

1. 客户端连接参数

1.1 默认配置

auto config = std::make_shared<Config>();
config->setAccessKey("<YOUR AK>");
config->setSecretKey("<YOUR SK>");
config->setPoolId("poolId");

1.2 个性化配置

auto config = std::make_shared<Config>();
config->setAccessKey("<YOUR AK>");
config->setSecretKey("<YOUR SK>");
config->setPoolId("poolId");
auto httpRequest = std::make_shared<HttpRequest>();
auto client = std::make_shared<Client>(config,httpRequest);

1.3 超时配置

auto config = std::make_shared<Config>();
config->setAccessKey("<YOUR AK>");
config->setSecretKey("<YOUR SK>");
config->setPoolId("poolId");
config->setReadTimeOut(5);

2. 客户端认证信息

认证参数说明

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

2.1 使用 AK 和 SK

auto config = std::make_shared<Config>();
config->setAccessKey("<YOUR AK>");
config->setSecretKey("<YOUR SK>");
config->setPoolId("poolId");

3. 客户端初始化

auto config = std::make_shared<Config>();
config->setAccessKey("<YOUR AK>");
config->setSecretKey("<YOUR SK>");
config->setPoolId("poolId");
auto client = std::make_shared<Client>(config);

4. 发送请求并查看响应

VmGetServerPortsRequest vmGetServerPortsRequest;
VmGetServerPortsPath vmGetServerPortsPath;
vmGetServerPortsPath.setServerId("test001");
vmGetServerPortsRequest.setVmGetServerPortsPath(vmGetServerPortsPath);
auto result = client->vmGetServerPorts(vmGetServerPortsRequest);

5. 异常处理

SDK 对程序执行过程中各类异常以ApiException进行统一收口。

try {
    response = client.VmGetServerPorts(request)
} catch (ApiException &e) {
    std::cout << e.what() << std::endl;
}

6.使用CMakeLists构建工程

  • 构建单个工程

    SET(BUILD_PRO ecloudsdkecs)
    SET(BUILD_VERSION v1)
    if (BUILD_PRO STREQUAL "all" OR BUILD_PRO STREQUAL "")
        add_subdirectory(ecloudsdkcore)
        message(STATUS "Build all Services")
    else ()
        add_subdirectory(ecloudsdkcore)
        add_subdirectory(${BUILD_PRO}/src/${BUILD_VERSION})
    endif ()
  • 构建多个工程

add_subdirectory(ecloudsdkcore)
add_subdirectory(ecloudsdkecs/src/v1)
add_subdirectory(ecloudsdktag/src/v1)
add_subdirectory(ecloudsdkims/src/v1)
木兰宽松许可证, 第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平台的C++ SDK,可以让C++开发者无需关心API请求细节即可快速使用弹性云服务器、虚拟私有云等多个移动云服务。 展开 收起
C++ 等 2 种语言
MulanPSL-2.0
取消

贡献者

全部

近期动态

加载更多
不能加载更多了
C++
1
https://gitee.com/chinamobile_ecloud/ecloud-sdk-cpp.git
git@gitee.com:chinamobile_ecloud/ecloud-sdk-cpp.git
chinamobile_ecloud
ecloud-sdk-cpp
ecloud-sdk-cpp
master

搜索帮助