Alibaba Cloud SDK:SDK の統合

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'yourAccessKeyID', [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'yourAccessKeySecret', [System.EnvironmentVariableTarget]::User)

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'yourAccessKeyID', [System.EnvironmentVariableTarget]::Machine)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'yourAccessKeySecret', [System.EnvironmentVariableTarget]::Machine)

$env:ALIBABA_CLOUD_ACCESS_KEY_ID = "yourAccessKeyID"
$env:ALIBABA_CLOUD_ACCESS_KEY_SECRET = "yourAccessKeySecret"

SDK の使用

このトピックでは、Short Message Service (SMS) の SendMessageToGlobe API を例として使用します。SendMessageToGlobe API の詳細については、「SendMessageToGlobe」をご参照ください。

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

SDK では、すべての OpenAPI 呼び出しはリクエストクライアント (Client) から開始されます。OpenAPI を呼び出す前に、リクエストクライアントを初期化する必要があります。リクエストクライアントは複数の方法で初期化できます。この例では、AccessKey を使用してクライアントを初期化する方法を示します。初期化メソッドの詳細については、「アクセス認証情報の管理」をご参照ください。

public static com.aliyun.dysmsapi20180501.Client createClient() throws Exception {
    com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
            // 必須、環境変数 ALIBABA_CLOUD_ACCESS_KEY_ID が設定されていることを確認してください。
            .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
            // 必須、環境変数 ALIBABA_CLOUD_ACCESS_KEY_SECRET が設定されていることを確認してください。
            .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
    // https://api.alibabacloud.com/product/Dysmsapi をご参照ください。
    config.endpoint = "dysmsapi.aliyuncs.com";
    return new com.aliyun.dysmsapi20180501.Client(config);
}

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

OpenAPI を呼び出すとき、SDK が提供するリクエストオブジェクトを使用してパラメーターを渡すことができます。OpenAPI のリクエストオブジェクトは、<OpenAPIName>Request 形式で名前が付けられます。たとえば、SendSms API のリクエストオブジェクトは SendSmsRequest です。リクエストパラメーターの詳細については、SendMessageToGlobe の API ドキュメントをご参照ください。

com.aliyun.dysmsapi20180501.models.SendMessageToGlobeRequest sendMessageToGlobeRequest = new com.aliyun.dysmsapi20180501.models.SendMessageToGlobeRequest()
                .setTo("8521245567****")
                .setMessage("Hello");

3. リクエストの開始

リクエストクライアントを使用して OpenAPI を呼び出す場合、<apiName>WithOptions 形式の関数を使用することをお勧めします。ここで、<apiName> はキャメルケースの OpenAPI の名前です。この関数は、前のステップのリクエストオブジェクトと実行時パラメーターの 2 つのパラメーターを取ります。実行時パラメーターは、タイムアウト設定やプロキシ設定などのリクエスト動作を設定します。詳細については、「高度な設定」をご参照ください。

OpenAPI のレスポンスオブジェクトは、<OpenAPIName>Response 形式で名前が付けられます。たとえば、SendSms API のレスポンスオブジェクトは SendSmsResponse です。

com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
Client client = createClient();
// API を呼び出します
client.sendMessageToGlobeWithOptions(sendMessageToGlobeRequest, runtime);

4. 例外の処理

Java SDK は、例外を `TeaUnretryableException` と `TeaException` に分類します。

• `TeaUnretryableException`: この例外は通常、ネットワークの問題が原因で発生し、最大リトライ回数に達した後にスローされます。

• `TeaException`: この例外は、主にビジネスエラーが原因で発生します。

例外処理の詳細については、「例外処理」をご参照ください。

import com.aliyun.dysmsapi20180501.Client;
import com.aliyun.dysmsapi20180501.models.SendMessageToGlobeRequest;
import com.aliyun.dysmsapi20180501.models.SendMessageToGlobeResponse;
import com.aliyun.tea.TeaException;
import com.aliyun.tea.TeaUnretryableException;
import com.aliyun.teaopenapi.models.Config;
import com.aliyun.teautil.models.RuntimeOptions;
import com.google.gson.Gson;

public class Sample {
    public static Client createClient() throws Exception {
        Config config = new Config()
                // 必須、環境変数 ALIBABA_CLOUD_ACCESS_KEY_ID が設定されていることを確認してください。
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // 必須、環境変数 ALIBABA_CLOUD_ACCESS_KEY_SECRET が設定されていることを確認してください。
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        // https://api.alibabacloud.com/product/Dysmsapi をご参照ください。
        config.endpoint = "dysmsapi.aliyuncs.com";
        return new Client(config);
    }

    public static void main(String[] args_) {
        try {
            Client client = Sample.createClient();
            SendMessageToGlobeRequest sendMessageToGlobeRequest = new SendMessageToGlobeRequest()
                    .setTo("8521245567****")
                    .setMessage("Hello");
            RuntimeOptions runtime = new RuntimeOptions();

            SendMessageToGlobeResponse sendMessageToGlobeResponse = client.sendMessageToGlobeWithOptions(sendMessageToGlobeRequest, runtime);
            System.out.println(new Gson().toJson(sendMessageToGlobeResponse.body));
        } catch (TeaUnretryableException ue) {
            // 印刷例のみです。例外処理には注意し、エンジニアリングプロジェクトで例外を直接無視しないでください。
            ue.printStackTrace();
            // エラーメッセージを出力
            System.out.println(ue.getMessage());
            System.out.println(ue.getLastRequest());
        } catch (TeaException e) {
            // 印刷例のみです。例外処理には注意し、エンジニアリングプロジェクトで例外を直接無視しないでください。
            e.printStackTrace();
            // エラーメッセージを出力
            System.out.println(e.getCode());
            System.out.println(e.getMessage());
            System.out.println(e.getData());
        } catch (Exception e) {
            // 印刷例のみです。例外処理には注意し、エンジニアリングプロジェクトで例外を直接無視しないでください。
            e.printStackTrace();
        }
    }
}

/**
 * <dependency>
 *   <groupId>com.aliyun</groupId>
 *   <artifactId>facebody20191230</artifactId>
 *   <version>5.1.2</version>
 * </dependency>
 */

import com.aliyun.tea.*;
import com.google.gson.Gson;
import java.nio.file.Files;
import java.nio.file.Paths;

public class Sample {

    public static com.aliyun.facebody20191230.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                // 必須。System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID") は環境変数から AccessKey ID を取得します。
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // 必須。System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET") は環境変数から AccessKey Secret を取得します。
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        config.regionId = "cn-shanghai";
        config.endpoint = "facebody.cn-shanghai.aliyuncs.com";
        return new com.aliyun.facebody20191230.Client(config);
    }

    public static void main(String[] args_) {
        try {
            com.aliyun.facebody20191230.Client client = Sample.createClient();
            com.aliyun.facebody20191230.models.DetectBodyCountAdvanceRequest detectBodyCountAdvance = new com.aliyun.facebody20191230.models.DetectBodyCountAdvanceRequest()
                    .setImageURLObject(Files.newInputStream(Paths.get("<FILE_PATH>")));  // <FILE_PATH> を実際のファイルパスに置き換えます。
            com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
            com.aliyun.facebody20191230.models.DetectBodyCountResponse resp = client.detectBodyCountAdvance(detectBodyCountAdvance, runtime);
            System.out.println(new Gson().toJson(resp.body));
        } catch (TeaUnretryableException ue) {
            ue.printStackTrace();
            // エラーメッセージを出力します。
            System.out.println(ue.getMessage());
            // エラー発生時にリクエスト情報をクエリするためにリクエストレコードを出力します。
            System.out.println(ue.getLastRequest());
        } catch (TeaException e) {
            e.printStackTrace();
            // エラーコードを出力します。
            System.out.println(e.getCode());
            // RequestId を含むエラーメッセージを出力します。
            System.out.println(e.getMessage());
            // サーバーから返された特定のエラー内容を出力します。
            System.out.println(e.getData());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

よくある質問

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

  原因: 使用している AccessKey に対応する Resource Access Management (RAM) ユーザーに、API を呼び出す権限がありません。

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

  たとえば、SendMessageToGlobe を呼び出すときに「You are not authorized to perform this operation.」エラーが返された場合は、次のカスタムポリシーを作成し、対応する権限を RAM ユーザーに付与できます。

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

• OpenAPI を呼び出すと、「The specified endpoint can't operate this region.」というエラーメッセージが返されます。

  原因: 呼び出している OpenAPI は、リクエストクライアントを初期化したときに指定したエンドポイントをサポートしていません。

  解決策: 「エンドポイントの設定」をご参照いただき、エンドポイントを変更して、OpenAPI を再度呼び出してください。

• OpenAPI を呼び出すと、「java.lang.NullPointerException...」というエラーメッセージが返されます。

  原因: AccessKey が正しく渡されませんでした。

  解決策: リクエストクライアントを初期化するときに、AccessKey が正しく渡されているかどうかを確認します。System.getenv("XXX") は環境変数から XXX の値を取得することに注意してください。

SDK の使用時に発生するエラーのその他の解決策については、「よくある質問」をご参照ください。