add readme

2018-05-05 20:37:58 +08:00
parent 1911aed209
commit 07e2b81c13
6 changed files with 539 additions and 118 deletions
--- a/README_zh.md
+++ b/README_zh.md
@@ -0,0 +1,118 @@
+# 阿里云开发者C++工具套件
+
+欢迎使用阿里云开发者工具套件（SDK）。
+
+适用于阿里云的 C++ SDK 提供了一组现代化的 C++（C++ 11 或更高版本）接口，让您不用复杂编程即可访问云服务器、云监控等多个阿里云服务。
+
+完成本文档中的操作开始使用 C++ SDK。
+
+## 前提条件
+
+在使用 C++ SDK 前，确保您已经：
+
+* 注册了阿里云账号并获取了访问密钥（AccessKey）。
+
+> **说明：** 为了保证您的账号安全，建议您使用RAM账号来访问阿里云服务。阿里云账号对拥有的资源有全部权限。RAM账号由阿里云账号授权创建，仅有对特定资源限定的操作权限。详情[参见RAM](https://help.aliyun.com/document_detail/28647.html)。
+
+* 开通了云产品服务。有些云产品如对象存储（OSS）需要先在[阿里云控制台](https://home.console.aliyun.com)开通服务。
+
+* 安装支持 C++ 11 或更高版本的编译器：
+	* Visual Studio 2015 或以上版本
+	* 或 GCC 4.9 或以上版本
+
+## 从源代码构建 SDK
+
+1. 从 GitHub 下载或 Git 克隆 [aliyun-openapi-cpp-sdk](https://github.com/aliyun/aliyun-openapi-cpp-sdk)
+
+* 直接下载 https://github.com/aliyun/aliyun-openapi-cpp-sdk/archive/master.zip
+* 使用 Git 命令获取
+
+```
+git clone https://github.com/aliyun/aliyun-openapi-cpp-sdk.git
+```
+
+2. 安装 cmake 3.0 或以上版本，进入 SDK 创建生成必要的构建文件
+
+```
+cd <path/to/aliyun-openapi-cpp-sdk>
+mkdir sdk_build
+cd sdk_build
+cmake ..
+```
+
+### Windows
+
+进入 sdk_build 目录使用 Visual Studio 打开 alibabacloud-sdk.sln 生成解决方案。
+
+或者您也可以使用 VS 的开发人员命令提示符，执行以下命令编译并安装：
+
+```
+msbuild ALL_BUILD.vcxproj
+msbuild INSTALL.vcxproj
+```
+
+### Linux
+
+要在 Linux 平台进行编译, 您必须安装依赖的外部库文件 libcurl、libopenssl、libuuid、libjsoncpp, 通常情况下，系统的包管理器中的会有提供。
+
+例如：在基于 Redhat / Fedora 的系统上安装这些软件包
+
+```
+sudo dnf install libcurl-devel openssl-devel libuuid-devel libjsoncpp-devel
+```
+
+在安装依赖库后执行以下命令编译并安装：
+
+```
+make
+sudo make install
+```
+
+## 如何使用 C++ SDK
+
+在调用 C++ SDK时，您首先需要配置预处理器定义 ALIBABACLOUD_SHARED 以引用阿里云 C++ SDK 的共享库，然后通过创建 Client 实例提供身份验证，并指定云服务的地域，然后发送API请求。
+
+以下代码展示了如何调用 DescribeInstancesAPI 查询指定地域所有 ECS 实例的详细信息。
+
+> **说明：** 您需要替换示例中的 your-region-id、your-access-key-id 和 your-access-key-secret 的值。
+
+```
+#include <iostream>
+#include <alibabacloud/core/AlibabaCloud.h>
+#include <alibabacloud/ecs/EcsClient.h>
+
+using namespace AlibabaCloud;
+using namespace AlibabaCloud::Ecs;
+
+int main(int argc, char** argv)
+{
+	// 初始化 SDK
+	AlibabaCloud::InitializeSdk();
+
+	// 配置 ecs 实例
+	ClientConfiguration configuration("<your-region-id>");
+	EcsClient client("<your-access-key-id>", "<your-access-key-secret>", configuration);
+
+	// 创建API请求并设置参数
+	Model::DescribeInstancesRequest request;
+	request.setPageSize(10);
+
+	auto outcome = client.describeInstances(request);
+	if (!outcome.isSuccess()) 
+	{
+		// 异常处理
+		std::cout << outcome.error().errorCode() << std::endl;
+		AlibabaCloud::ShutdownSdk();
+		return -1;
+	}
+	
+	std::cout << "totalCount: " << outcome.result().getTotalCount() << std::endl;
+
+	// 关闭 SDK
+	AlibabaCloud::ShutdownSdk();
+	return 0;
+}
+```
+
+## 许可协议
+请参阅 LICENSE 文件（Apache 2.0 许可证）。