Elastic Desktop Service:Install EDS Enterprise SDK for Java

Install by using sample code from OpenAPI Explorer

1. Open the DescribeOfficeSites document and click the Debug option in the upper-right corner of the page.

2. Log on to OpenAPI Portal by using your Alibaba Cloud account.

3. Configure the required parameters and click Initiate Call to obtain the response.

4. To access the sample code after debugging, go to the SDK Sample Code tab in the right panel, choose your preferred programming language, and then click Download Project.

   Note

   The complete project includes the SDK details and a demo for API operation calls.

5. Open IntelliJ IDEA. In the top navigation bar, choose File > Open, open and decompress the sample project folder. Then, wait for Maven to automatically install relevant dependencies.

6. Double-click Sample.java and click the icon in the upper-right corner of the page.

7. View the execution result. In the log window, press Ctrl+F and search for statusCode. If "statusCode":200, the call is successful.

Install in an existing project

1. Obtain EDS Enterprise SDK for Java.

   Go to the SDK Center of EDS Enterprise and choose an installation method. In this example, Apache Maven is used.

   

2. Integrate the SDK into your application.

   Open the Maven project created in IntelliJ IDEA, insert the <dependencies></dependencies> tag pair into the pom.xml file, and then insert the Apache Maven dependencies obtained in the previous step into the tag pair.

   <dependencies>
     <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>alibabacloud-ecd20200930</artifactId>
       <version>4.0.21</version>
     </dependency>
   </dependencies>

3. Download dependencies.

   Right-click the project name and choose Maven > Reload project from the shortcut menu to download Maven dependencies.

4. Create a Java class.

   Right-click the src/main/java directory and select New > Java Class, enter the name Sample, and press Enter.

   

5. Initialize the cloud service client.

   Important

   • To initialize the client, you must use an AccessKey pair for identity verification. Ensure you obtain the AccessKey pair beforehand. For more information about how to obtain an AccessKey pair, see Create an AccessKey pair.

   • After you obtain the AccessKey pair of a RAM user, you must configure the AccessKey pair in environment variables. For more information, see Configure environment variables in Linux, macOS, and Windows.

   • For information about endpoints, see Endpoints.

   import com.aliyun.ecd20200930.Client;
   import com.aliyun.teaopenapi.models.Config;
   
   public class Sample {
       public static void main(String[] args) throws Exception {
           Config config = new Config()
                   .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                   .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
           config.endpoint = "ecd.cn-shanghai.aliyuncs.com";
           Client client = new Client(config);
       }
   }

6. Call an API operation.

   Before you call an API operation, you must read the corresponding API document. In Maven dependencies for a cloud service, the cloud service SDK includes a request class and a response class for each API operation. The request class specifies the parameters and their value types, while the response class defines the structure of the response. This design helps avoid spelling errors when you call the operation.

   Note

   • Naming rule for request classes: API operation name + Request Example: DescribeOfficeSitesRequest.

   • Naming rule for response classes: API operation name + Response Example: DescribeOfficeSitesResponse.

   import com.aliyun.ecd20200930.Client;
   import com.aliyun.ecd20200930.models.DescribeOfficeSitesRequest;
   import com.aliyun.ecd20200930.models.DescribeOfficeSitesResponse;
   import com.aliyun.teaopenapi.models.Config;
   
   public class Sample {
       public static void main(String[] args) throws Exception {
               Config config = new Config()
                       .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                       .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
               config.endpoint = "ecd.cn-shanghai.aliyuncs.com";
               Client client = new Client(config);
               DescribeOfficeSitesRequest describeOfficeSitesRequest = new DescribeOfficeSitesRequest()
                   .setRegionId("cn-shanghai");
               DescribeOfficeSitesResponse describeOfficeSitesResponse = client.describeOfficeSites(describeOfficeSitesRequest, runtime);
       }
   }

7. Handle exceptions.

   Alibaba Cloud SDKs manage exceptions uniformly.

   TeaException: triggered by business-related errors. The following parameters can assist in troubleshooting the issue:

   • Message: the error message returned when an exception occurs. It includes the request ID.

   • Data: the detailed error information returned by the server for the exception.