All Products
Search

This Product

    Server Migration Center:Use SMC SDK for Java

    Document Center

    Server Migration Center:Use SMC SDK for Java

    Last Updated:May 23, 2024

    This topic describes how to call an API operation in OpenAPI Explorer to obtain and use the sample code of Server Migration Center (SMC) SDK for Java.

    Prerequisites

    • The version of the Java Development Kit (JDK) is 1.8 or later and Java environment variables are configured.

    • A Java developer tool is downloaded and installed.

      In this example, IntelliJ IDEA is used.

    • An AccessKey pair is obtained.

      When you call an API operation, you must use an AccessKey pair to complete identity authentication. An AccessKey pair consists of an AccessKey ID and an AccessKey secret. For more information about how to create an AccessKey pair, see Create an AccessKey pair.

    Procedure

    Step 1: Download the complete SDK project

    1. Go to the

      API Debugging page of OpenAPI Explorer. In the left-side navigation pane, click the API operation that you want to call.

      In this example, the DescribeSourceServers operation is used.

    2. In the DescribeSourceServers pane, select a region and configure parameters on the Parameters tab. You can see API reference to view information related to the API, such as the description, usage notes, and expenses of the API operations and the specific meaning and usage of each parameter.

    3. Click the SDK Sample Code tab on the right. Select Java as Languages and click Download Project.

      Note

    Step 2: Import the decompressed project

    1. Open IntelliJ IDEA.

    2. In the top navigation bar, select File > New > Project from Existing Sources....

      image.png

    3. In the dialog box that appears, select the decompressed SDK project file.

    Step 3: Configure credentials

    Configure the credentials that are required when you call the API operations of Alibaba Cloud services. You can define the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables to configure the default credentials. When you call an API operation, the system reads the AccessKey pair from the default credentials and uses the AccessKey pair to complete authentication.

    You can use multiple configuration methods to configure credentials. For more information, see Configure credentials.

    1. In the pom.xml file, add the following Maven dependency to install the Alibaba Cloud SDK Credentials package.

      Note

      The Alibaba Cloud SDK Credentials package is continuously updated. For more information about the latest version, see ChangeLog at Github. 

      <dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>credentials-java</artifactId>
    <version>0.2.11</version>
</dependency>

      image.png

    2. Right-click the pom.xml file and choose Maven > Reload project. Then, Maven automatically downloads required JAR packages for the pom.xml file.

    3. Configure the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables. For more information, see Configure environment variables in Linux, macOS, and Windows.

      Note

      For more information about how to create an AccessKey pair, see Create an AccessKey pair.

    Step 4: Run the SDK sample code

    1. In the left-side navigation pane of IntelliJ IDEA, open the SDK for Java sample code file.

    2. In the top navigation bar, select Run > Run... to run the sample code.

      image.png

    3. Check the result of the code.

      image.png

    You can configure an HTTPS request, a proxy, a timeout period, or a retry mechanism for the SDK based on your business requirements. For more information, see Advanced configuration.