Alibaba Cloud SDK:汎用呼び出し

dotnet add package aliyun-net-sdk-core

using Aliyun.Acs.Core;
using Aliyun.Acs.Core.Profile;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample
    {
        public static void Main(string[] args)
        {
            IClientProfile profile = DefaultProfile.GetProfile(
                // リージョン ID を指定します。
                "<REGION_ID>",
                // Resource Access Management (RAM) ユーザーの AccessKey ID を環境変数から取得します。
                Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
                // RAM ユーザーの AccessKey シークレットを環境変数から取得します。
                Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
            DefaultAcsClient client = new DefaultAcsClient(profile);
        }
    }
}

       // 2. API リクエストを作成し、リクエスト パラメーターを構成します。
        CommonRequest request = new CommonRequest();
        // 2.1 共通リクエスト パラメーターを構成します。
        request.Domain = "ecs-cn-hangzhou.aliyuncs.com"; // サービスのエンドポイント。
        request.Version = "2014-05-26"; // サービスの API バージョン。
        request.Action = "DescribeInstanceStatus"; // API 操作の名前。 操作名は、リモートプロシージャコール (RPC) API 操作には必須であり、リソース指向アーキテクチャ (ROA) API 操作にはオプションです。
        request.Method = MethodType.POST; // リクエストメソッド。 値: MethodType.POST、MethodType.GET、MethodType.PUT、MethodType.DELETE、MethodType.HEAD、および MethodType.OPTIONS。
        request.Protocol = ProtocolType.HTTPS; // リクエストプロトコル。 有効な値: ProtocolType.HTTPS および ProtocolType.HTTP。
        request.TimeoutInMilliSeconds = 1000; // タイムアウト期間。
        // request.UriPattern = "/";  // リソースパス。 ROA スタイルの API 操作で必要です。 RPC スタイルの API 操作では、このパラメーターを構成しないでください。

        // 2.2 操作固有のパラメーターを構成します。
        // シナリオ 1: AddQueryParameters(string key,string value) でクエリパラメーターを指定します。
        request.AddQueryParameters("RegionId", "cn-hangzhou");
        List<string> instanceIds = new List<string> { "i-bp124uve8zq7XXXXXXXX", "i-bp1axhql4dqaXXXXXXXX" };
        for (int i = 0; i < instanceIds.Count; i++) {
		request.AddQueryParameters($"InstanceId.{i + 1}" , instanceIds[i]);
	    }
        request.AddQueryParameters("PageNumber", "1");
        request.AddQueryParameters("PageSize", "30");

        // シナリオ 2: AddBodyParameters(string key,string value) でボディパラメーターを指定します。
        // request.AddBodyParameters("key1", "value1");
        // request.AddBodyParameters("key2", "value2");

        // シナリオ 3: ファイルをアップロードするには、SetContent(byte[] content,string charset,FormatType formatType) を指定します。 formatType を FormatType.RAW に設定します。
        // byte[] content = File.ReadAllBytes(@"<FILE_PATH>");
        // request.SetContent(content, "UTF-8",FormatType.RAW);
        

CommonResponse response = client.GetCommonResponse(request);
System.Console.WriteLine(response.Data);

次のサンプル コードは、CommonRequest を使用して ECS の DescribeInstanceStatus 操作を呼び出す方法の例を示しています。

using Aliyun.Acs.Core;
using Aliyun.Acs.Core.Exceptions;
using Aliyun.Acs.Core.Profile;
class Sample
{
    static void Main(string[] args)
    {
        // リクエストを開始するためのクライアント インスタンスを作成します。
        IClientProfile profile = DefaultProfile.GetProfile(
            // リージョン ID を指定します。
            "cn-hangzhou",
            // RAM ユーザーの AccessKey ID を環境変数から取得します。
            Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
            // RAM ユーザーの AccessKey ID を環境変数から取得します。
            Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        DefaultAcsClient client = new DefaultAcsClient(profile);
        try
        {
            // リクエストを構築します。
            CommonRequest request = new CommonRequest();
            request.Domain = "ecs.aliyuncs.com";
            request.Version = "2014-05-26";
            // RPC API 操作の ApiName (Action) パラメーターの値を指定します。
            request.Action = "DescribeInstanceStatus";
            request.AddQueryParameters("RegionId", "cn-hangzhou");
            List<string> instanceIds = new List<string> { "i-bp124uve8zq7XXXXXXXX", "i-bp1axhql4dqaXXXXXXXX" };
            for (int i = 0; i < instanceIds.Count; i++) {
                    request.AddQueryParameters($"InstanceId.{i + 1}" , instanceIds[i]);
                }
            request.AddQueryParameters("PageNumber", "1");
            request.AddQueryParameters("PageSize", "30");
            // リクエストを開始し、レスポンスを取得します。
            CommonResponse response = client.GetCommonResponse(request);
            System.Console.WriteLine(response.Data);
        }
        catch (ServerException ex)
        {
            System.Console.WriteLine(ex.ToString());
        }
        catch (ClientException ex)
        {
            System.Console.WriteLine(ex.ToString());
        }
    }
}

次のサンプル コードは、CommonRequest を使用して ACK の API 操作を呼び出し、すべてのクラスターをクエリする方法の例を示しています。

using Aliyun.Acs.Core;
using Aliyun.Acs.Core.Exceptions;
using Aliyun.Acs.Core.Profile;
class Sample
{
    static void Main(string[] args)
    {
        // リクエストを開始するためのクライアント インスタンスを作成します。
        IClientProfile profile = DefaultProfile.GetProfile(
            // リージョン ID を指定します。
            "<REGION-ID>",
            // RAM ユーザーの AccessKey ID を環境変数から取得します。
            Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
            // RAM ユーザーの AccessKey ID を環境変数から取得します。
            Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        DefaultAcsClient client = new DefaultAcsClient(profile);
        try
        {
            // リクエストを構築します。
            CommonRequest request = new CommonRequest();
            request.Domain = "cs.aliyuncs.com";
            request.Version = "2015-12-15";
            // Restful API 操作の UriPattern パラメーターの値を指定します。
            request.UriPattern = "/clusters";
            // リクエストを開始し、レスポンスを取得します。
            CommonResponse response = client.GetCommonResponse(request);
            System.Console.WriteLine(response.Data);
        }
        catch (ServerException ex)
        {
            System.Console.WriteLine(ex.ToString());
        }
        catch (ClientException ex)
        {
            System.Console.WriteLine(ex.ToString());
        }
    }
}

よくある質問

1. 「このリクエストの処理に必須の入力パラメーター \"AccessKeyId\" が提供されていません。」というエラー メッセージが返された場合はどうすればよいですか?

   原因: AccessKey ペアが正しく構成されていません。

   解決策:

   1. 次のコマンドを実行して、ALIBABA_CLOUD_ACCESS_KEY_ID および ALIBABA_CLOUD_ACCESS_KEY_SECRET 環境変数が構成されているかどうかを確認します。

      Linux/macOS

      echo $ALIBABA_CLOUD_ACCESS_KEY_ID
      echo $ALIBABA_CLOUD_ACCESS_KEY_SECRET

      Windows

      echo %ALIBABA_CLOUD_ACCESS_KEY_ID%
      echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%

      有効な AccessKey ペアが返された場合、環境変数は正しく構成されています。 AccessKey ペアが返されない場合、または無効な AccessKey ペアが返された場合は、必要に応じて環境変数を構成します。 詳細については、「Linux、macOS、および Windows で環境変数を構成する」をご参照ください。

   2. コード内で AccessKey ペアに関連するエラーを確認します。

      エラー リクエストの例:

      AccessKeyId = Environment.GetEnvironmentVariable("yourAccessKeyID"),
      AccessKeySecret = Environment.GetEnvironmentVariable("yourAccessKeySecret"),

      成功リクエストの例:

      Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"), 
      Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET")

2. 「処理されていない例外。 Aliyun.Acs.Core.Exceptions.ClientException: SDK.WebException : HttpWebRequest WebException が発生しました。リクエスト URL は XXX.cn-hangzhou.aliyuncs.com System.Net.WebException: リクエストの送信中にエラーが発生しました。」というエラー メッセージが返された場合はどうすればよいですか?

   原因: RPC スタイルの API 操作の共通リクエスト パラメーターで UriPattern パラメーターが構成されています。

   解決策: 共通リクエスト パラメーターから UriPattern パラメーターを削除します。