最近更新时间:2023.08.23 11:25:00
首次发布时间:2022.05.25 17:01:28
本文为您介绍火山引擎Java SDK的下载地址及安装方式。
要使用火山引擎Java SDK访问指定服务的API ,请确认您已在 火山引擎控制台 开通当前服务。
您已获取账号的AccessKey,具体步骤,请参见获取AccessKey。
您确认已安装Java JDK 1.7或以上版本,您可以下载最新版本: http://developers.sun.com/downloads/。
Java SDK下载地址:volcengine-java-sdk
当SDK版本大于或者等于0.1.28时,volcengine-java-sdk会在Maven中央仓库发布,您可以无需执行本步骤。但字节跳动的Maven仓库更新时间会比Maven中央仓库提早几个小时,您也可以按需选用字节跳动的Maven仓库。
当SDK版本小于0.1.28时,volcengine-java-sdk并未在Maven中央仓库发布,而是在字节跳动对外的Maven仓库发布,因此您在使用前,请先在Maven的安装目录conf/settings.xml
中,针对字节跳动的Maven仓库进行镜像设置,设置方法如下:
# 请将如下设置加入到 <mirror>标签中 <mirror> <id>bytedanceMaven</id> <mirrorOf>my-repo-id</mirrorOf> <name>字节跳动maven仓库</name> <url>https://artifact.bytedance.com/repository/releases/</url> </mirror>
新建一个Maven项目,在项目目录下的pom.xml
中,添加如下设置,引入服务依赖。引入依赖后,Maven项目管理工具会自动下载相关jar包。
独立服务包
您可以按需引入服务依赖,以VPC、ECS、EBS服务为例,您需要引入volcengine-java-sdk-vpc、volcengine-java-sdk-ecs和volcengine-java-sdk-storageebs。
<dependencies> <dependency> <groupId>com.volcengine</groupId> <artifactId>volcengine-java-sdk-vpc</artifactId> <version>0.1.61</version> </dependency> <dependency> <groupId>com.volcengine</groupId> <artifactId>volcengine-java-sdk-ecs</artifactId> <version>0.1.61</version> </dependency> <dependency> <groupId>com.volcengine</groupId> <artifactId>volcengine-java-sdk-storageebs</artifactId> <version>0.1.61</version> </dependency> </dependencies>
全部SDK包
如果您需要引入SDK的全部服务,可以通过bom
方式引入。如下文所示,引入volcengine-java-sdk-bom后,即可引入所有支持的服务:
<dependencyManagement> <dependencies> <dependency> <groupId>com.volcengine</groupId> <artifactId>volcengine-java-sdk-bom</artifactId> <version>0.1.61</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement>
本文以查询指定Region下的实例信息为例,为您介绍如何使用Java SDK。
新建TestVpc.java
文件,参考DescribeInstances的请求参数说明,添加如下代码。
package com.volcengine.ecs.examples; import com.volcengine.ApiClient; import com.volcengine.ApiException; import com.volcengine.sign.Credentials; import com.volcengine.ecs.EcsApi; import com.volcengine.ecs.model.*; import java.util.*; public class TestDescribeInstances { public static void main(String[] args) throws Exception { //设置您的ak String ak = "Your AK"; //设置您的sk String sk = "Your SK"; //设置您要访问的地域,本示例为北京地域 String region = "cn-beijing"; //初始化apiclient ApiClient apiClient = new ApiClient() .setCredentials(Credentials.getCredentials(ak, sk)) .setRegion(region); EcsApi api = new EcsApi(apiClient); //创建一个DescribeInstance接口 DescribeInstancesRequest describeInstancesRequest = new DescribeInstancesRequest(); //设置接口入参,本示例仅传入实例ID,即InstanceIds describeInstancesRequest.setInstanceIds(Arrays.asList("i-3ti9101aju3vj0******")); // 发起请求并处理返回或异常 try { DescribeInstancesResponse response = api.describeInstances(describeInstancesRequest); System.out.println(response); } catch (ApiException e) { System.out.println(e.getResponseBody()); } } }
如果您的Java版本高于或者等于JDK 9,则需要依赖javax.annotation-api,请在pom.xml
中添加如下内容:
<dependency> <groupId>javax.annotation</groupId> <artifactId>javax.annotation-api</artifactId> <version>1.3.2</version> </dependency>