|
1 |
| -# Alibaba Cloud C++ Software Development Kit |
2 |
| -[中文文档](./README_zh.md) |
| 1 | +English | [简体中文](./README_zh.md) |
3 | 2 |
|
4 |
| -[](https://travis-ci.org/aliyun/aliyun-openapi-cpp-sdk) |
5 |
| -[](https://codecov.io/gh/aliyun/aliyun-openapi-cpp-sdk) |
6 | 3 |
|
7 |
| -The Alibaba Cloud C++ Software Development Kit (SDK) allows you to access Alibaba Cloud services such as Elastic Compute Service (ECS), Server Load Balancer (SLB), and CloudMonitor. You can access Alibaba Cloud services without the need to handle API related tasks, such as signing and constructing your requests. |
| 4 | +<p align="center"> |
| 5 | +<a href="https://www.alibabacloud.com"><img src="https://aliyunsdk-pages.alicdn.com/icons/AlibabaCloud.svg"></a> |
| 6 | +</p> |
8 | 7 |
|
9 |
| -This document introduces how to obtain and call Alibaba Cloud C++ SDK. |
| 8 | +<h1 align="center">Alibaba Cloud SDK for C++</h1> |
| 9 | + |
| 10 | +<p align="center"> |
| 11 | +<a href="https://travis-ci.org/aliyun/aliyun-openapi-cpp-sdk"><img src="https://travis-ci.org/aliyun/aliyun-openapi-cpp-sdk.svg?branch=master" alt="Travis Build Status"></a> |
| 12 | +<a href="https://codecov.io/gh/aliyun/aliyun-openapi-cpp-sdk"><img src="https://codecov.io/gh/aliyun/aliyun-openapi-cpp-sdk/branch/master/graph/badge.svg" alt="codecov"></a> |
| 13 | +</p> |
| 14 | + |
| 15 | + |
| 16 | +The SDK allows you to access Alibaba Cloud services such as Elastic Compute Service (ECS), Server Load Balancer (SLB), and CloudMonitor. You can access Alibaba Cloud services without the need to handle API related tasks, such as signing and constructing your requests. |
| 17 | + |
| 18 | +This document introduces how to obtain and call this SDK. |
10 | 19 |
|
11 | 20 | If you have any problem while using C++ SDK, please submit an [issue](https://github.com/aliyun/aliyun-openapi-cpp-sdk/issues/new).
|
12 | 21 |
|
13 |
| -## Prerequisites |
| 22 | +## Requirements |
14 | 23 |
|
15 |
| -- To use Alibaba Cloud C++ SDK, you must have an Alibaba Cloud account and an AccessKey. |
| 24 | +- To use this SDK, you must have an Alibaba Cloud account and an AccessKey. |
16 | 25 |
|
17 | 26 | The AccessKey is required when initializing the client. You can create an AccessKey in the Alibaba Cloud console. For more information, see [Create an AccessKey](https://usercenter.console.aliyun.com/?spm=5176.doc52740.2.3.QKZk8w#/manage/ak).
|
18 | 27 |
|
19 | 28 | >**Note:** To increase the security of your account, we recommend that you use the AccessKey of the RAM user to access Alibaba Cloud services.
|
20 | 29 |
|
21 |
| -- To use Alibaba Cloud C++ SDK to access the APIs of a product, you must first activate the product on the [Alibaba Cloud console](https://home.console.aliyun.com/?spm=5176.doc52740.2.4.QKZk8w) if required. |
| 30 | +- To use this SDK to access the APIs of a product, you must first activate the product on the [Alibaba Cloud console](https://home.console.aliyun.com/?spm=5176.doc52740.2.4.QKZk8w) if required. |
22 | 31 |
|
23 | 32 | - C++11 supported compiler installed
|
24 | 33 | - Windows: Visual Studio 2015 or newer
|
25 | 34 | - Linux: GCC 4.9 or newer
|
26 | 35 | - CMake 3.0 or newer
|
27 | 36 | - 4G memory or more
|
28 | 37 |
|
29 |
| -## Install C++ SDK from source code |
30 |
| - |
| 38 | +## Installation |
31 | 39 |
|
32 | 40 | ### Linux
|
33 | 41 |
|
@@ -106,9 +114,9 @@ If you have any problem while using C++ SDK, please submit an [issue](https://gi
|
106 | 114 | **SDK will be installed to `C:\Program File (x86)\alibabacloud-sdk`**
|
107 | 115 |
|
108 | 116 |
|
109 |
| -## Use the C++ SDK |
| 117 | +## Quick Examples |
110 | 118 |
|
111 |
| -Before using C++ SDK, you must first configure the preprocessor to define `ALIBABACLOUD_SHARED` to achieve dynamic linking with Alibaba Cloud C++ SDK shared libraries. Then you must create a client instance, specify the region of cloud services and provide authentication parameters before sending API requests. |
| 119 | +Before using this SDK, you must first configure the preprocessor to define `ALIBABACLOUD_SHARED` to achieve dynamic linking with the SDK shared libraries. Then you must create a client instance, specify the region of cloud services and provide authentication parameters before sending API requests. |
112 | 120 |
|
113 | 121 | The following code shows how to call the [DescribeInstances](~~25506~~) API of ECS to query detailed information of all ECS instances in a specific region.
|
114 | 122 |
|
@@ -222,9 +230,18 @@ int main(int argc, char** argv) {
|
222 | 230 |
|
223 | 231 | ```
|
224 | 232 |
|
| 233 | +**More [examples](https://github.com/aliyun/aliyun-openapi-cpp-sdk/tree/master/examples)** |
225 | 234 |
|
| 235 | +## Issues |
| 236 | +[Opening an Issue](https://github.com/aliyun/aliyun-openapi-cpp-sdk/issues/new/choose), Issues not conforming to the guidelines may be closed immediately. |
226 | 237 |
|
227 |
| -**More [examples](https://github.com/aliyun/aliyun-openapi-cpp-sdk/tree/master/examples)** |
| 238 | +## Changelog |
| 239 | +Detailed changes for each release are documented in the [release notes](CHANGELOG). |
| 240 | +
|
| 241 | +## Contribution |
| 242 | +Please make sure to read the [Contributing Guide](CONTRIBUTING.md) before making a pull request. |
| 243 | +
|
| 244 | +## License |
| 245 | +[Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
228 | 246 |
|
229 |
| -## LICENSE |
230 |
| -Please refer to [LICENSE](https://github.com/aliyun/aliyun-openapi-cpp-sdk/blob/master/LICENSE) (Apache 2.0 LICENSE). |
| 247 | +Copyright 1999-2019 Alibaba Group Holding Ltd. |
0 commit comments