更新时间:2022-05-09 GMT+08:00
分享

.NET SDK

本章节介绍.NET SDK,您可以参考本章节进行快速集成开发。

准备工作

  • 已注册华为云帐号,并完成实名认证,帐号不能处于欠费或冻结状态。
  • 已具备开发环境,.NET SDK 适用于.NET Standard 2.0 及其以上版本;C# 4.0 及其以上版本。
  • 登录“我的凭证 > 访问秘钥”页面,获取Access Key(AK)和Secret Access Key(SK)。
  • 登录“我的凭证”页面,获取“IAM用户名”“、帐号名”以及待使用区域的“项目ID”。调用服务时会用到这些信息,请提前保存。

    本样例以“华北-北京四”区域为例,获取对应的项目ID(project_id)。

    图1 我的凭证

安装SDK

使用SDK前,需要安装“HuaweiCloud.SDK.Core”和“HuaweiCloud.SDK.Ocr”,有两种安装方式,分别如下。

  • 使用 .NET CLI 工具
    dotnet add package HuaweiCloud.SDK.Core
    dotnet add package HuaweiCloud.SDK.Ocr
  • 使用 Package Manager
    Install-Package HuaweiCloud.SDK.Core
    Install-Package HuaweiCloud.SDK.Ocr

开始使用

详细的SDK介绍,使用异步客户端,配置日志请参见SDK中心.NET SDK使用指导

  1. 导入依赖模块
    using System;
    using System.Collections.Generic;
    using HuaweiCloud.SDK.Core;
    using HuaweiCloud.SDK.Core.Auth;
    using HuaweiCloud.SDK.Ocr;
    using HuaweiCloud.SDK.Ocr.V1;
    using HuaweiCloud.SDK.Ocr.V1.Model;
  2. 配置客户端连接参数
    • 默认配置
      // 使用默认配置
      var config = HttpConfig.GetDefaultConfig();
    • 网络代理(可选)
      // 根据需要配置网络代理
      config.ProxyHost = "proxy.huaweicloud.com";
      config.ProxyPort = 8080;
      config.ProxyUsername = "test";
      config.ProxyPassword = "test";
    • 超时配置(可选)
      // 默认超时时间为120秒,可根据需要调整
      config.Timeout = 120;
    • SSL配置(可选)
      // 根据需要配置是否跳过SSL证书验证
      config.IgnoreSslVerification = true;
  3. 配置认证信息

    配置AK、SK信息。华为云通过AK识别用户的身份,通过SK对请求数据进行签名验证,用于确保请求的机密性、完整性和请求者身份的正确性。AK、SK获取方法请参见准备工作

    const string ak = "<YOUR AK>";
    const string sk = "<YOUR SK>";
    var auth = new BasicCredentials(ak, sk);
  4. 初始化客户端(二选一)
    • 指定云服务region方式(推荐)
      // 初始化指定云服务的客户端 {Service}Client ,以初始化OCR服务的 OcrClient 为例
      var client = OcrClient.NewBuilder()
          .WithCredential(auth)
          .WithRegion(OcrRegion.ValueOf("cn-north-4"))
          .WithHttpConfig(config)
          .Build();
    • 指定云服务endpoint方式
      // 指定终端节点,以OCR服务北京四的 endpoint 为例
      String endpoint = "https://ocr.cn-north-4.myhuaweicloud.com";
      // 初始化客户端认证信息,需要填写相应 projectId,以初始化 BasicCredentials 为例
      var auth = new BasicCredentials(ak, sk, projectId);
      
      // 初始化指定云服务的客户端 {Service}Client,以初始化OCR服务的 OcrClient 为例
      var client = OcrClient.NewBuilder()
          .WithCredential(auth)
          .WithEndPoint(endpoint)
          .WithHttpConfig(config)
          .Build();

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

  5. 发送请求并查看响应
    // 以调用通用表格识别接口 RecognizeGeneralTable 为例
    var req = new RecognizeGeneralTableRequest
    {
    };
    req.Body = new GeneralTableRequestBody()
    {
        Url = "图片的url"
    };
    try
    {
        var resp = client.RecognizeGeneralTable(req);
        var respStatusCode = resp.HttpStatusCode;
        Console.WriteLine(respStatusCode);
    }
  6. 异常处理
    表1 异常处理

    一级分类

    一级分类说明

    二级分类

    二级分类说明

    ConnectionException

    连接类异常

    HostUnreachableException

    网络不可达、被拒绝。

    SslHandShakeException

    SSL认证异常。

    RequestTimeoutException

    响应超时异常

    CallTimeoutException

    单次请求,服务器处理超时未返回。

    RetryOutageException

    在重试策略消耗完成后,仍无有效的响应。

    ServiceResponseException

    服务器响应异常

    ServerResponseException

    服务端内部错误,Http响应码:[500,]。

    ClientRequestException

    请求参数不合法,Http响应码:[400, 500)

    try
    {
       var resp = client.RecognizeGeneralTable(req);
       var respStatusCode = resp.HttpStatusCode;
       Console.WriteLine(respStatusCode);
    }
    catch (RequestTimeoutException requestTimeoutException)
    {
        Console.WriteLine(requestTimeoutException.ErrorMessage);
     }
        catch (ServiceResponseException clientRequestException)
    {
        Console.WriteLine(clientRequestException.HttpStatusCode);
        Console.WriteLine(clientRequestException.ErrorCode);
        Console.WriteLine(clientRequestException.ErrorMsg);
    }
        catch (ConnectionException connectionException)
    {
        Console.WriteLine(connectionException.ErrorMessage);
    }

代码示例自动生成

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

您只需要在API Explorer中修改接口参数,即可自动生成对应的代码示例。同时,可在集成开发环境CloudIDE中完成代码的构建、调试、运行等操作。

图2 API Explorer
分享:

    相关文档

    相关产品

close