C++ SDK

准备工作

• 注册华为账号并开通华为云，账号不能处于欠费或冻结状态。
• 已具备开发环境，支持 C++ 14 及以上版本，要求安装 CMake 3.10 及以上版本。
• 登录“我的凭证 > 访问密钥”页面，依据界面操作指引获取Access Key（AK）和Secret Access Key（SK）。下载的访问密钥为credentials.csv文件，包含AK/SK信息。
  图1 新增访问密钥
  

  

• 登录“我的凭证”页面，获取“IAM用户名”、“账号名”以及待使用区域的“项目ID”。调用服务时会用到这些信息，请提前保存。
  图2 我的凭证
  

安装SDK

• 在Linux系统上安装SDK
  1. 获取依赖包

     所需的这些第三方软件包在大部分系统的包管理工具中都有提供，例如基于 Debian/Ubuntu 的系统。

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

     spdlog 需要从源码进行安装。

     git clone https://github.com/gabime/spdlog.git
     cd spdlog
     mkdir build
     cd build
     cmake -DCMAKE_POSITION_INDEPENDENT_CODE=ON ..  // 用以生成动态库
     make
     sudo make install

  2. 编译安装

     git clone https://github.com/huaweicloud/huaweicloud-sdk-cpp-v3.git
     cd huaweicloud-sdk-cpp-v3
     mkdir build
     cd build
     cmake ..
     make
     sudo make install

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

• 在Windows系统上安装SDK
  1. 安装 vcpkg 并使用 vcpkg 安装所需软件包

     vcpkg install curl cpprestsdk boost openssl spdlog

  2. 使用CLion进行编译
     1. 使用CLion打开huaweicloud-sdk-cpp-v3 目录。
     2. 选择“File > Settings”。
     3. 选择“Build, Execution, Deployment > > CMake”。
     4. 在CMake options中加入：

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

     5. 右键 CMakeLists.txt 选择 Load CMake Project。
     6. 选择Build开始编译。
  3. 安装C++ SDK

     编译完成后选择“Build > Install”。

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

开始使用

1. 导入依赖模块

   //include <cstdlib>
   //include <iostream>
   //include <string>
   //include <memory>
   //include <huaweicloud/core/exception/Exceptions.h>
   //include <huaweicloud/core/Client.h>
   //include <huaweicloud/ocr/v1/OcrClient.h>
   using namespace HuaweiCloud::Sdk::Ocr::V1;
   using namespace HuaweiCloud::Sdk::Ocr::V1::Model;
   using namespace HuaweiCloud::Sdk::Core;
   using namespace HuaweiCloud::Sdk::Core::Exception;
   using namespace std;

2. 配置客户端连接参数
   • 默认配置

     // 使用默认配置
     HttpConfig httpConfig = HttpConfig();

   • 网络代理（可选）

     // 根据需要配置网络代理
     httpConfig.setProxyProtocol("http");
     httpConfig.setProxyHost("proxy.huawei.com");
     httpConfig.setProxyPort("8080");
     httpConfig.setProxyUser("username");
     httpConfig.setProxyPassword("password");

   • 超时配置（可选）

     // 默认连接超时为60秒，默认读取超时为120秒。可根据需求修改该默认值
     httpConfig.setConnectTimeout(60);
     httpConfig.setReadTimeout(120);

   • SSL配置（可选）

     // 配置跳过服务端证书验证
     httpConfig.setIgnoreSslVerification(true);

3. 配置认证信息
   配置AK、SK、projectId信息。华为云通过AK识别用户的身份，通过SK对请求数据进行签名验证，用于确保请求的机密性、完整性和请求者身份的正确性。

   string ak = getenv("HUAWEICLOUD_SDK_AK");
   string sk = getenv("HUAWEICLOUD_SDK_SK");
   string projectId = getenv("PROJECT_ID");
   auto auth = std::make_unique<BasicCredentials>();
   auth->withAk(ak)
      .withSk(sk)
      .withProjectId(projectId);

   

   • 认证用的 ak 和sk 硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全。
   • 本示例以 ak 和 sk 保存在环境变量中来实现身份验证为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。

   认证参数说明：

   • ak、sk：访问密钥信息，获取方法请参见准备工作。
   • projectId：华为云项目ID，获取方法请参见准备工作。
4. 初始化客户端
   指定云服务endpoint方式

   string endpoint = "https://ocr.cn-north-4.myhuaweicloud.com";
   auto client = OcrClient::newBuilder()
           .withCredentials(std::unique_ptr<Credentials>(auth.release()))
           .withHttpConfig(httpConfig)
           .withEndPoint(endpoint)
           .build();

   endpoint：华为云各服务应用区域和各服务的终端节点，详情请查看 地区和终端节点。

5. 发送请求并查看响应

   // 以调用护照识别接口 RecognizePassport 为例
   RecognizePassportRequest request;
   PassportRequestBody body;
   body.setUrl("图片的url");
   request.setBody(body);
   
   std::cout << "-----begin execute request-------" << std::endl;

6. 异常处理

   表1 异常处理

   一级分类	一级分类说明	二级分类	二级分类说明
   ConnectionException	连接类异常	HostUnreachableException	网络不可达、被拒绝。
   		SslHandShakeException	SSL认证异常。
   RequestTimeoutException	响应超时异常	CallTimeoutException	单次请求，服务器处理超时未返回。
   		RetryOutageException	在重试策略消耗完成后，仍无有效的响应。
   ServiceResponseException	服务器响应异常	ServerResponseException	服务端内部错误，Http响应码：[500,]。
   		ClientRequestException	请求参数不合法，Http响应码：[400, 500)

   std::cout << "-----begin execute request-------" << std::endl;
   try {
       auto reponse = client->recognizePassport(request);
       std::cout << reponse->getHttpBody() << std::endl;
   } catch (HostUnreachableException& e) {
       std::cout << "host unreachable:" << e.what() << std::endl;
   } catch (SslHandShakeException& e) {
       std::cout << "ssl handshake error:" << e.what() << std::endl;
   } catch (RetryOutageException& e) {
       std::cout << "retryoutage error:" << e.what() << std::endl;
   } catch (CallTimeoutException& e) {
       std::cout << "call timeout:" <<  e.what() << std::endl;
   } catch (ServiceResponseException& e) {
       std::cout << "http status code:" << e.getStatusCode() << std::endl;
       std::cout << "error code:" << e.getErrorCode() << std::endl;
       std::cout << "error msg:" << e.getErrorMsg() << std::endl;
       std::cout << "RequestId:" << e.getRequestId() << std::endl;
   } catch (exception& e) {
       std:cout << "unknown exception:" << e.what() << std::endl;
   }

代码示例自动生成

API Explorer提供API检索及平台调试，支持全量快速检索、可视化调试、帮助文档查看、在线咨询。

您只需要在API Explorer中修改接口参数，即可自动生成对应的代码示例。

图3 API Explorer