# aliyun-openapi-cpp-sdk

**Repository Path**: shercode/aliyun-openapi-cpp-sdk

## Basic Information

- **Project Name**: aliyun-openapi-cpp-sdk
- **Description**: AliYun OpenAPI C++ SDK
- **Primary Language**: C++
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2015-10-29
- **Last Updated**: 2021-11-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### AliYun Open API SDK for C++ developers
This SDK aimed to provide an Object-Oriented and full stack solution for you to build applications 
on AliYun, supporting aas, ace, ace-ops, alert, batchcompute, aas, ace, ace-ops, alert, batchcompute, bss, 
cdn, cms, crm, drds, dts, ecs, emr, ess, ocs, oms, ons, ossadmin, ots, otsfinance, otsshihua, pts, push, ram, rds, 
rds-region, r-kvstore, slb, sts, ubsms and yundun.

### Requirements
VS2015, G++ 4.6
	
### Dependence
This SDK depends on the following third-party library - **libcurl openssl**. If you want to parse the raw response 
from the AliYun, you can use **libxml2** to parse the XML response or use **jsoncpp** to parse the JSON response. 
I recommend using the latter. The SDK does not include these third-party library, so your have to download 
and install them by yourself.

### Quick Start

	#include <cstdlib>
	#include <iostream>
	#include <string>
	#include "aliyun-cpp-sdk-core/DefaultProfile.h"
	#include "aliyun-cpp-sdk-ecs/EcsService.h"
	int main() {
		AliYunCore::DefaultProfile profile( "cn-hangzhou", "AccessKeyId", "AccessKeySecret" );
		AliYunEcs::EcsClient client( profile );
		AliYunEcs::EcsDescribeRegionsRequest req;
		std::string response = client.getResponse( req );
		std::cout << response << std::endl;
		return EXIT_SUCCESS;
	}

response as below:

	{
		"RequestId": "091465F4-A31F-419E-8FAE-E63AF0073B58",
		"Regions": {
			"Region": [{
				"RegionId": "ap-southeast-1",
				"LocalName": "亚太（新加坡）"
			},
			{
				"RegionId": "cn-shenzhen",
				"LocalName": "深圳"
			},
			{
				"RegionId": "cn-qingdao",
				"LocalName": "青岛"
			},
			{
				"RegionId": "cn-beijing",
				"LocalName": "北京"
			},
			{
				"RegionId": "cn-shanghai",
				"LocalName": "上海"
			},
			{
				"RegionId": "cn-hongkong",
				"LocalName": "香港"
			},
			{
				"RegionId": "cn-hangzhou",
				"LocalName": "杭州"
			},
			{
				"RegionId": "us-west-1",
				"LocalName": "美国硅谷"
			}]
		}
	}
	
	
This SDK has two kinds of namespace - AliYunCore and AliYun{servicename} (e.g. AliYunEcs, AliYunRds). If you
want to use the ecs service, you have to include these files:

	"aliyun-cpp-sdk-core/DefaultProfile.h"
	"aliyun-cpp-sdk-ecs/EcsService.h" 

The "DefaultProfile.h" is implemented in the AliYunCore namespace and the "EcsService.h" is implemented in the AliYunEcs
namespace. There are two kinds of classes in the namespace of AliYunEcs, one is EcsClient and another is api request.
If you want to call the api of "DescribeRegions", you have to instantiate an object of the class "EcsDescribeRegionsRequest".
The last step is to trigger the function of "getResponse" with the request object. The default reponse is JSON, 
but if you prefer XML, you can set the property of request just like this:

	AliYunEcs::EcsDescribeRegionsRequest req;
	req.Format = "XML";
	std::string response = client.getResponse( req );
	
In many apis, you have to supply some important parameters, you can do as follows:

	AliYunEcs::EcsStartInstanceRequest req;
	req.addParameter("InstanceId", "instance-1", "Query");
	req.Format = "XML";
	std::string response = client.getResponse( req );

"InstanceId" is the name of the parameter; "instance-1" is the value, and "Query" is the position, whoes  
default value is "Query", but also can be "Query", "Body", "Path", "Domain" or "Header" according to the 
official API document.

**Note: you don't have to supply the "Action" parameter, because the request knows its Action and will send it 
to AliYun server automatically.**

### License
licensed under the [Apache License 2.0](https://www.apache.org/licenses/)