You need to enable JavaScript to run this app.
导航

Java安装指导

最近更新时间2023.08.23 11:58:27

首次发布时间2023.07.05 15:21:24

本文为您介绍火山引擎Java SDK的下载地址及安装方式。

前提条件

SDK下载地址

Java SDK下载地址:volcengine-java-sdk

安装SDK

步骤一:设置字节跳动Maven镜像仓库(可选)

当SDK版本大于或者等于0.1.28时,volcengine-java-sdk会在Maven中央仓库发布,您可以无需执行本步骤。但字节跳动的Maven仓库更新时间会比Maven中央仓库提早几个小时,您也可以按需选用字节跳动的Maven仓库。<br
当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项目依赖

新建一个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>
    

使用Java SDK

本文以查询指定VPN网关信息为例,为您介绍如何使用Java SDK。
新建TestVpn.java文件,参考DescribeVpnGatewayAttributes的请求参数说明,添加如下代码。

package com.volcengine.vpn.examples;

import com.volcengine.ApiClient;
import com.volcengine.ApiException;
import com.volcengine.sign.Credentials;

import com.volcengine.vpn.VpnApi;
import com.volcengine.vpn.model.*;


public class TestDescribeVpnGatewayAttributes {
    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);

        VpnApi api = new VpnApi(apiClient);
        
        // 创建DescribeVpnGatewayAttributes接口。
        DescribeVpnGatewayAttributesRequest describeVpnGatewayAttributesRequest = new DescribeVpnGatewayAttributesRequest();
        // 设置接口入参,本示例仅传入实例ID,即VpnGatewayId。
        describeVpnGatewayAttributesRequest.setVpnGatewayId("vgw-12bfa2du7fojk17q7y1rk****");
        
        // 发起请求并处理返回或异常。
        try {
            DescribeVpnGatewayAttributesResponse response = api.describeVpnGatewayAttributes(describeVpnGatewayAttributesRequest);
            System.out.println(response);
        } catch (ApiException e) {
            System.out.println(e.getResponseBody());
        }
    }
}

附录:关于Java JDK 9+的特殊说明

如果您的Java版本高于或者等于JDK 9,则需要依赖javax.annotation-api,请在pom.xml中添加如下内容:

<dependency>
  <groupId>javax.annotation</groupId>
  <artifactId>javax.annotation-api</artifactId>
  <version>1.3.2</version>
</dependency>