edit-icon download-icon

Getting started

Last Updated: Mar 23, 2018

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.

This document introduces how to obtain and call Alibaba Cloud C++ SDK.

If you have any problem while using C++ SDK, please join the DingTalk group: 11771185 (the official SDK customer service group of Alibaba Cloud) for consultation.


  • To use Alibaba Cloud C++ SDK, you must have an Alibaba Cloud account and an AccessKey.

    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.

    Note: To increase the security of your account, we recommend that you use the AccessKey of the RAM user to access Alibaba Cloud services.

  • To use Alibaba Cloud C++ SDK to access the APIs of a product, you must first activate the product on the Alibaba Cloud console if required.

Install C++ SDK

  1. Install third-party libraries on the Linux platform, including libcurl, libopenssl, libuuid, and libjsoncpp.

    • Run the following commands on the Redhat/Fedora system to install third-party libraries.
      1. sudo dnf install libcurl-devel openssl-devel libuuid-devel libjsoncpp-devel
    • Run the following commands on the Debian/Ubuntu system to install third-party libraries.
      1. sudo apt-get install libcurl4-openssl-dev libssl-dev uuid-dev libjsoncpp-dev
  2. Run the following commands to clone source codes from GitHub.
  1. git clone https://github.com/aliyun/aliyun-openapi-cpp-sdk.git

Use the C++ SDK

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.

The following code shows how to call the DescribeInstances API of ECS to query detailed information of all ECS instances in a specific region.

  1. #include <iostream>
  2. #include <alibabacloud/core/AlibabaCloud.h>
  3. #include <alibabacloud/ecs/EcsClient.h>
  4. using namespace AlibabaCloud;
  5. using namespace AlibabaCloud::Ecs;
  6. int main(int argc, char** argv)
  7. {
  8. // Initialize the SDK
  9. AlibabaCloud::InitializeSdk();
  10. // Configure the ECS instance
  11. ClientConfiguration configuration("<your-region-id>");
  12. EcsClient client("<your-access-key-id>", "<your-access-key-secret>", configuration);
  13. // Create an API request and set parameters
  14. Model::DescribeInstancesRequest request;
  15. request.setPageSize(10);
  16. auto outcome = client.describeInstances(request);
  17. if (!outcome.isSuccess())
  18. {
  19. // Handle exceptions
  20. std::cout << outcome.error().errorCode() << std::endl;
  21. AlibabaCloud::ShutdownSdk();
  22. return -1;
  23. }
  24. std::cout << "totalCount: " << outcome.result().getTotalCount() << std::endl;
  25. // Close the SDK
  26. AlibabaCloud::ShutdownSdk();
  27. return 0;
  28. }
Thank you! We've received your feedback.