You need to enable JavaScript to run this app.
导航
Java SDK
最近更新时间:2024.04.18 19:09:06首次发布时间:2022.11.17 10:15:08

本文主要描述镜像仓库 Java 语言 SDK 的安装和配置,及使用 Java SDK 调用云端 API 的示例。

使用说明

  • 仅支持 Java JDK 1.7 及以上版本。您可以从 Java 官网 下载最新的版本。
  • 如果使用 Java 9 及以上版本,需要依赖javax.annotation-api
    由于在 Java 9 及以上的版本中, javax.annotation-api被移除,因此需要在项目文件中加入以下依赖。
    <dependency>
    	<groupId>javax.annotation</groupId>
    	<artifactId>javax.annotation-api</artifactId>
    	<version>1.3.2</version>
    </dependency>
    

安装配置

推荐通过 Maven 管理和使用 JAVA SDK。

  1. 在本地使用 Maven 构建您的项目。

  2. 添加 Maven 项目依赖。
    需要使用字节跳动的 Maven 仓库来完成依赖,请先编辑 Maven 安装目录的conf/setting.xml文件,增加镜像配置。

    <mirror>
         <id>bytedanceMaven</id>
         <mirrorOf>my-repo-id</mirrorOf>
         <name>字节跳动maven仓库</name>
         <url>https://artifact.bytedance.com/repository/releases/</url>
    </mirror>
    
  3. 导入并配置 pom.xml 文件。

    <dependencyManagement>
      <dependencies>
        <dependency>
          <groupId>com.volcengine</groupId>
              <artifactId>volcengine-java-sdk-bom</artifactId>
            <version>0.1.6</version>
              <type>pom</type>
          <scope>import</scope>
        </dependency>
      </dependencies>
    </dependencyManagement>
    
  4. 使用 SDK Maven 模块。

    <dependency>
        <groupId>com.volcengine</groupId>
        <artifactId>volcengine-java-sdk-cr</artifactId>
        <version>1.0.75</version>
    </dependency>
    

证书配置

镜像仓库支持如下两种证书配置方法:

  • 通过环境变量导入
    export VOLCENGINE_ACCESS_KEY=your_ak // 您的 Access Key ID
    export VOLCENGINE_SECRET_KEY=your_sk // 您的 Secret Access Key
    
  • 通过代码方式引入:
    Credentials credentials = Credentials.getCredentials(ak,sk);
    

SDK 示例

本文以查询实例接口 ListRegistries为例。

package com.volcengine.cr;

import com.volcengine.ApiClient;
import com.volcengine.ApiException;
import com.volcengine.cr.model.FilterForListRegistriesInput;
import com.volcengine.cr.model.ListRegistriesRequest;
import com.volcengine.cr.model.ListRegistriesResponse;
import com.volcengine.cr.model.StatusForListRegistriesInput;
import com.volcengine.sign.Credentials;

public class test {
    public static void main(String[] args) {
        String ak = "AKLT****"; // 您的 Access Key ID
        String sk = "WTJG****";// 您的 Secret Access Key
        String region = "cn-beijing";// 您的业务所在地域

        ApiClient apiClient = new ApiClient()
                .setCredentials(Credentials.getCredentials(ak, sk))
                .setRegion(region);
        CrApi crApi = new CrApi(apiClient);

        StatusForListRegistriesInput statusListRregistries = new StatusForListRegistriesInput();
        statusListRregistries.setCondition("Ok");
        statusListRregistries.setPhase("Running");

        ListRegistriesRequest listRegistries = new ListRegistriesRequest();
        listRegistries.setPageNumber((long) 1);
        listRegistries.setPageSize((long) 10);

        // 用例1 names_null_types_all_status_exist
        FilterForListRegistriesInput filterListRregistries = new FilterForListRegistriesInput();
        filterListRregistries.addTypesItem("Basic");
        filterListRregistries.addTypesItem("Enterprise");
        filterListRregistries.addStatusesItem(statusListRregistries);
        listRegistries.setFilter(filterListRregistries);
        try {
            ListRegistriesResponse respListRegistries = crApi.listRegistries(listRegistries);
            System.out.println(listRegistries);
            System.out.println(respListRegistries);
        } catch (ApiException e) {
            System.out.println(e.getResponseBody());
        }
    }
}