Alibaba Cloud SDK:SDK の統合

1. SDK Center にログインし、使用する SDK のサービスを選択します。 この例では、Short Message Service (SMS) が選択されています。

2. [Short Message Service] ページで、[すべての言語] セクションで [C#] を選択します。[クイックスタート] タブで、Short Message Service (SMS) SDK のインストール方法を取得します。

特殊なシナリオ：Advance 操作によるファイルのアップロード

オンプレミスのマシン上のイメージを処理したり、イメージをアップロードしたりするために Image Search または Visual Intelligence API (VIAPI) を使用する場合、ドキュメントに記載されている Image Search または VIAPI の API は直接アップロードをサポートしていません。イメージをアップロードするには、ファイルストリームの転送をサポートする Advance 操作を使用する必要があります。クラウドサービスは、アップロードされたファイルを Object Storage Service (OSS) に一時的に保存し、必要に応じて OSS から一時ファイルを読み取ります。OSS のデフォルトリージョンは cn-shanghai です。次の例では、VIAPI の DetectBodyCount 操作を呼び出す方法を示します。

1. リクエストクライアントの初期化

   クラウドサービスの RegionId パラメーターと endpoint の両方が指定されていることを確認してください。RegionId は、一時ファイルが保存される OSS リージョンを示します。RegionId パラメーターを設定しない場合、クラウドサービスが OSS とは異なるリージョンを使用し、API タイムアウトが発生する可能性があります。

   public static AlibabaCloud.SDK.Facebody20191230.Client CreateClient()
   {
       AlibabaCloud.OpenApiClient.Models.Config config =
           new AlibabaCloud.OpenApiClient.Models.Config
           {
               // 必須。次の環境変数がコード実行環境に設定されていることを確認してください：ALIBABA_CLOUD_ACCESS_KEY_ID。
               AccessKeyId = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
               // 必須。次の環境変数がコード実行環境に設定されていることを確認してください：ALIBABA_CLOUD_ACCESS_KEY_SECRET。
               AccessKeySecret = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),
           };
       config.RegionId = "cn-shanghai";
       config.Endpoint = "facebody.cn-shanghai.aliyuncs.com";
       return new AlibabaCloud.SDK.Facebody20191230.Client(config);
   }

2. リクエストオブジェクトの作成

   <API 操作>AdvanceRequest リクエストオブジェクトを作成して、ファイルストリームを渡します。リクエストオブジェクトで、パラメーター名を ImageURLObject に設定します。

   AlibabaCloud.SDK.Facebody20191230.Models.DetectBodyCountAdvanceRequest detectBodyCountAdvanceRequest =
       new AlibabaCloud.SDK.Facebody20191230.Models.DetectBodyCountAdvanceRequest
       {
           ImageURLObject = File.OpenRead(@"<FILE_PATH>"), // <FILE_PATH> を実際のファイルパスに置き換えます。
       };   

3. リクエストの開始

   <API 操作名>Advance 関数を呼び出してリクエストを開始します。

   // 実行時パラメーターを設定します。
   AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();
   AlibabaCloud.SDK.Facebody20191230.Client client = CreateClient();
   // リクエストを送信します。
   AlibabaCloud.SDK.Facebody20191230.Models.DetectBodyCountResponse response = client.DetectBodyCountAdvance(detectBodyCountAdvanceRequest, runtime);
   Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(response));

// dotnet add package AlibabaCloud.SDK.Facebody20191230 --version 4.1.2

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample
    {
        public static AlibabaCloud.SDK.Facebody20191230.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config =
                new AlibabaCloud.OpenApiClient.Models.Config
                {
                    // 必須。次の環境変数がコード実行環境に設定されていることを確認してください：ALIBABA_CLOUD_ACCESS_KEY_ID。
                    AccessKeyId = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
                    // 必須。次の環境変数がコード実行環境に設定されていることを確認してください：ALIBABA_CLOUD_ACCESS_KEY_SECRET。
                    AccessKeySecret = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),
                };
            config.RegionId = "cn-shanghai";
            config.Endpoint = "facebody.cn-shanghai.aliyuncs.com";
            return new AlibabaCloud.SDK.Facebody20191230.Client(config);
        }

        public static void Main(string[] args)
        {
            try
            {
                AlibabaCloud.SDK.Facebody20191230.Client client = CreateClient();
                // <FILE_PATH> を実際のファイルパスに置き換えます。
                using (FileStream fileStream = File.OpenRead(@"<FILE_PATH>"))
                {
                    AlibabaCloud.SDK.Facebody20191230.Models.DetectBodyCountAdvanceRequest detectBodyCountAdvanceRequest =
                        new AlibabaCloud.SDK.Facebody20191230.Models.DetectBodyCountAdvanceRequest
                        {
                            ImageURLObject = fileStream,
                        };
                    AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();
                    AlibabaCloud.SDK.Facebody20191230.Models.DetectBodyCountResponse response =
                        client.DetectBodyCountAdvance(detectBodyCountAdvanceRequest, runtime);
                    Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(response));
                }
            }
            catch (TeaException error)
            {
                // 実際のビジネスシナリオに応じて例外を慎重に処理し、プロジェクト内で例外を無視しないようにしてください。この例で表示されるエラーメッセージは、あくまで参考用です。
                Console.WriteLine(error.Message);
                AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
            }
            catch (Exception _error)
            {
                TeaException error = new TeaException(
                    new Dictionary<string, object> { { "message", _error.Message } }
                );
                // 実際のビジネスシナリオに応じて例外を慎重に処理し、プロジェクト内で例外を無視しないようにしてください。この例で表示されるエラーメッセージは、あくまで参考用です。
                Console.WriteLine(error.Message);
                AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
            }
        }
    }
}

よくある質問

• OpenAPI を呼び出すと、「You are not authorized to perform this operation」というエラーメッセージが表示されます。

  原因：Resource Access Management (RAM) ユーザーが使用する AccessKey ペアに、API 操作を呼び出すための権限がありません。

  解決策：RAM ユーザーに必要な権限を付与してください。詳細については、「RAM ユーザーへの権限付与」をご参照ください。

  例えば、「You are not authorized to perform this operation」エラーが SendMessageToGlobe API 操作によってスローされた場合は、次のカスタムポリシーを作成して、RAM ユーザーに必要な権限を付与してください：

  {
    "Version": "1",
    "Statement": [
      {
        "Effect": "Allow",
        "Action": "dysms:SendMessageToGlobe",
        "Resource": "*"
      }
    ]
  }

• OpenAPI を呼び出すと、次のエラーが返されます：「System.UnretryableException: One or more errors occurred.」

  原因：リクエストクライアントの初期化時に指定したエンドポイントを、API 操作がサポートしていません。

  解決策：サポートされているエンドポイントを指定して、再試行してください。詳細については、「エンドポイントの設定」をご参照ください。

• OpenAPI の呼び出しで、次のエラーが返されます：ErrorCode":"InvalidAccessKeyId.NotFound","ErrorMessage":"Specified access key is not found."。

  原因：AccessKey ペアがリクエストに正しく渡されていません。

  解決策：リクエストクライアントを初期化する際に、AccessKey ペアが正しく渡されていることを確認してください。Environment.GetEnvironmentVariable("XXX") は、XXX の値が環境変数から取得されることを示します。

SDK エラーの処理方法の詳細については、「よくある質問」をご参照ください。