Docs

File Storage vePFS

Java SDK

Initialize the client

The vePFS Java client for file storage offers a range of interfaces to interact with the vePFS file storage service and manage resources. You must initialize the Java client before sending HTTP/HTTPS requests to the vePFS file storage service. This article explains how to initialize the Java client.

Prerequisites

vePFS Java SDK for file storage has been downloaded and installed. For detailed instructions, see Download and install the SDK.

When initializing the client, you need the following information:

Access Key ID (AK) and Secret Access Key (SK) for the account. For information on how to obtain AKSK, see View AKSK information.

Region information. The Region supported by vePFS file storage. For details, see Service Address.

Configure environment variables

Hardcoding the AccessKey in your business code poses security risks. We recommend managing the AccessKey by configuring environment variables.

Linux / macOS operating systems

The steps for configuring environment variables are as follows:

export VOLCENGINE_ACCESS_KEY_ID=<Your AccessKey ID>
export VOLCENGINE_ACCESS_KEY_SECRET=<Your AccessKey Secret>

Windows operating system

The steps for configuring environment variables are as follows:

Create a new environment variable file. Add the environment variables VOLCENGINE_ACCESS_KEY_ID and VOLCENGINE_ACCESS_KEY_SECRET, then write your AccessKey ID and AccessKey Secret.

Restart the Windows system.

Initialize the client

Use the following code to initialize the client.

package com.volcengine.vepfs.examples;​
​
import com.volcengine.ApiClient;​
import com.volcengine.ApiException;​
import com.volcengine.sign.Credentials;​
​
import com.volcengine.vepfs.VepfsApi;​
import com.volcengine.vepfs.model.*;​
​
public class Main {​
    public static VepfsApi api;​
    ​
    public static void initClient() {​
        // Set your AK​
        String ak = System.getenv("VOLCENGINE_ACCESS_KEY_ID");​
        // Set your SK​
        String sk = System.getenv("VOLCENGINE_ACCESS_KEY_SECRET");​
        // Set the region you want to access​
        String region = "Your Region";​
​
        // Create a vepfs SDK client. You can use it to call APIs and perform requests.​
        ApiClient apiClient = new ApiClient()​
                .setCredentials(Credentials.getCredentials(ak, sk))​
                .setRegion(region);​
        api = new VepfsApi(apiClient);​
    }​
}​

Last updated: 2026.03.03 10:39:10