https://github.com/volcengine/volc-sdk-java
https://github.com/volcengine/volc-sdk-java
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/volcengine/volc-sdk-java
- Owner: volcengine
- License: apache-2.0
- Created: 2020-10-25T13:52:35.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2026-01-15T12:02:23.000Z (5 months ago)
- Last Synced: 2026-01-17T22:17:40.792Z (5 months ago)
- Language: Java
- Size: 10.5 MB
- Stars: 84
- Watchers: 0
- Forks: 40
- Open Issues: 1
-
Metadata Files:
- Readme: README.EN.MD
- Changelog: Changelog
- License: LICENSE
Awesome Lists containing this project
README
English | [中文](README.md)
Volcengine SDK for Java
Welcome to Volcengine SDK for Java. This document explains how to obtain and use the SDK.
## Prerequisites
### Enable the service
Make sure the service you want to access is enabled. Go to the [Volcengine Console](https://console.volcengine.com/), select the service from the left navigation (or search it from the top bar), and complete the activation process in the service console.
### Obtain security credentials
Access Key is the credential used to access Volcengine services. It consists of Access Key ID (AK) and Secret Access Key (SK).
Log in to the [Volcengine Console](https://console.volcengine.com/), then go to [IAM](https://console.volcengine.com/iam) -> [Access Keys](https://console.volcengine.com/iam/keymanage/) to create and manage your Access Keys. For more information, see the [Access Key documentation](https://www.volcengine.com/docs/6291/65568).
## Install
We recommend using Maven dependencies to integrate Volcengine SDK for Java.
[](https://search.maven.org/artifact/com.volcengine/volc-sdk-java)
```xml
com.volcengine
volc-sdk-java
latest
```
If your Java version is **Java 9 or later**, add `javax.annotation-api` because it was removed from JDK 9+.
```xml
javax.annotation
javax.annotation-api
1.3.2
```
### SNAPSHOT release notes
[Version: 2.0.1-SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/com/volcengine/volc-sdk-java)
*Note: SNAPSHOT versions may have potential issues. The source branch is `2.0.0-SNAPSHOT`. If you need support, please submit a [ticket](https://console.volcengine.com/workorder/create) and select the corresponding product.*
#### Changes
1. Use OkHttp as the underlying HTTP component (Android compatible)
2. Fix potential thread leaks when using many credentials
3. Abstract some network-related models to avoid conflicts
4. Business packages are mostly unaffected, so migration should be smooth
How to use the SNAPSHOT version:
1. Add the SNAPSHOT Maven repository (SNAPSHOT policy settings are up to you)
```xml
snapshots-repo
https://oss.sonatype.org/content/repositories/snapshots/
```
2. Add dependency
```xml
com.volcengine
volc-sdk-java
2.0.1-SNAPSHOT
```
## Configuration
### Credential configuration
Volcengine SDK for Java supports the following credential loading methods.
*Note: Replace `Your AK` and `Your SK` in the code with your actual AK and SK.*
**Method 1**: Specify AK/SK explicitly on the client **(recommended)**
```java
iamService.setAccessKey("Your AK");
iamService.setSecretKey("Your SK");
```
**Method 2**: Load AK/SK from environment variables
```bash
VOLC_ACCESSKEY="Your AK"
VOLC_SECRETKEY="Your SK"
```
**Method 3**: Load AK/SK from a file under HOME
Add the following content to `~/.volc/config`:
```json
{
"ak": "Your AK",
"sk": "Your SK"
}
```
### Release resources
After calling APIs, explicitly call `destroy()` to release daemon threads.
```java
iamService.destroy()
```
## Other resources
Examples are available under [example](./example)