{"id":19411520,"url":"https://github.com/volcengine/volcengine-java-sdk","last_synced_at":"2026-01-11T16:56:07.174Z","repository":{"id":45600868,"uuid":"509070864","full_name":"volcengine/volcengine-java-sdk","owner":"volcengine","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-27T12:59:55.000Z","size":12089,"stargazers_count":48,"open_issues_count":1,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-09T17:20:06.219Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/volcengine.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-30T12:27:43.000Z","updated_at":"2025-04-01T03:54:39.000Z","dependencies_parsed_at":"2024-01-18T14:33:30.558Z","dependency_job_id":"e873f4b7-72a0-4a1b-aa8b-9649ec992fa1","html_url":"https://github.com/volcengine/volcengine-java-sdk","commit_stats":null,"previous_names":[],"tags_count":151,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volcengine%2Fvolcengine-java-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volcengine%2Fvolcengine-java-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volcengine%2Fvolcengine-java-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volcengine%2Fvolcengine-java-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/volcengine","download_url":"https://codeload.github.com/volcengine/volcengine-java-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248074928,"owners_count":21043491,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T12:21:50.672Z","updated_at":"2026-01-11T16:56:07.168Z","avatar_url":"https://github.com/volcengine.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"中文 | [English](README.EN.MD)\n\n# Volcengine SDK for Java\n\n## Table of Contents\n\n* Requirements\n* Usage\n* API Dosc\n* Note\n\n### Requirements ###\n\n运行 SDK需要jdk **Java 1.8.0_131+**. 你可以下载最新的版本： http://developers.sun.com/downloads/.\n如果 SDK版本 高于或者等于 **Java 9** 请依赖javax.annotation-api\n由于在高于或者等于 **Java 9** 中 javax.annotation-api 被移除\n\n请在使用中引用\n\n```xml\n\n\u003cdependency\u003e\n    \u003cgroupId\u003ejavax.annotation\u003c/groupId\u003e\n    \u003cartifactId\u003ejavax.annotation-api\u003c/artifactId\u003e\n    \u003cversion\u003e1.3.2\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### Usage ###\n\n* Getting Started\n* Example\n\n#### Getting Started ####\n\n##### 安装说明 #####\n\n建议使用Maven构建自己的项目，添加需要的相应模块的依赖，示例如下：\n\n##### Init maven setting.xml #####\n\n如果您使用的版本大于0.1.27 可以不进行设置 直接使用中央仓库进行依赖\n\n如果您使用的版本小于或者等于0.1.27\n需要使用字节跳动的maven仓库来完成依赖，请先到maven安装目录的conf/setting.xml\n在\u003cmirrors/\u003e标签中增加\n\n```xml\n\n\u003cmirror\u003e\n    \u003cid\u003ebytedanceMaven\u003c/id\u003e\n    \u003cmirrorOf\u003emy-repo-id\u003c/mirrorOf\u003e\n    \u003cname\u003e字节跳动maven仓库\u003c/name\u003e\n    \u003curl\u003ehttps://artifact.bytedance.com/repository/releases/\u003c/url\u003e\n\u003c/mirror\u003e\n```\n\n##### Importing the pom #####\n\n```xml\n\n\u003cdependencyManagement\u003e\n    \u003cdependencies\u003e\n        \u003cdependency\u003e\n            \u003cgroupId\u003ecom.volcengine\u003c/groupId\u003e\n            \u003cartifactId\u003evolcengine-java-sdk-bom\u003c/artifactId\u003e\n            \u003cversion\u003e1.0.5\u003c/version\u003e\n            \u003ctype\u003epom\u003c/type\u003e\n            \u003cscope\u003eimport\u003c/scope\u003e\n        \u003c/dependency\u003e\n    \u003c/dependencies\u003e\n\u003c/dependencyManagement\u003e\n```\n\n##### Using the SDK Maven modules #####\n\n```xml\n\n\u003cdependencies\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003ecom.volcengine\u003c/groupId\u003e\n        \u003cartifactId\u003evolcengine-java-sdk-vpc\u003c/artifactId\u003e\n        \u003cversion\u003e1.0.5\u003c/version\u003e\n    \u003c/dependency\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003ecom.volcengine\u003c/groupId\u003e\n        \u003cartifactId\u003evolcengine-java-sdk-ecs\u003c/artifactId\u003e\n        \u003cversion\u003e1.0.5\u003c/version\u003e\n    \u003c/dependency\u003e\n\u003c/dependencies\u003e\n```\n\n##### Credentials 配置 #####\n\n**通过环境变量导入**:\n\n```\nexport VOLCENGINE_ACCESS_KEY=your ak\nexport VOLCENGINE_SECRET_KEY=your sk\n#如果使用token\nexport VOLCENGINE_SESSION_TOKEN=token\n```\n\n**代码方式引入**：\n\n```java\nCredentials credentials = Credentials.getCredentials(ak, sk);\n//如果使用token\nCredentials credentials = Credentials.getCredentials(ak, sk, token);\n```\n\n##### Endpoint 设置 #####\n\n如果您要自定义SDK的Endpoint，可以按照以下示例代码设置：\n\n```java\nApiClient apiClient = new ApiClient()\n        .setCredentials(Credentials.getCredentials(ak, sk))\n        .setRegion(region).setEndpoint(\"ecs.cn-beijing-autodriving.volcengineapi.com\");\n```\n\n火山引擎标准的Endpoint规则说明：\n\n| Regional 服务                                                                                                                            | Global 服务                                                                          |\n|----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|\n| `{service}.{region}.volcengineapi.com` \u003cbr\u003e 例如：云服务ecs在cn-beijing-autodriving Region域名为： `ecs.cn-beijing-autodriving.volcengineapi.com` | `{service}.volcengineapi.com` \u003cbr\u003e 例如：访问控制iam为Global服务，域名为：`iam.volcengineapi.com` |\n\n注：\n\n- Service中存在_符号时，Endpoint时需转为-符号。存在大写字母时需转成小写。\n\n#### SDK 示例 ####\n\n```java\nimport com.volcengine.ApiClient;\nimport com.volcengine.ApiException;\nimport com.volcengine.sign.Credentials;\nimport com.volcengine.vpc.VpcApi;\nimport com.volcengine.vpc.model.DescribeVpcsRequest;\nimport com.volcengine.vpc.model.DescribeVpcsResponse;\n\nimport java.util.ArrayList;\nimport java.util.List;\n\npublic class TestVpc {\n    public static void main(String[] args) throws Exception {\n        String ak = \"your ak\";\n        String sk = \"your sk\";\n        String region = \"cn-beijing\";\n\n        ApiClient apiClient = new ApiClient()\n                .setCredentials(Credentials.getCredentials(ak, sk))\n                .setRegion(region);\n        VpcApi vpcApi = new VpcApi(apiClient);\n        DescribeVpcsRequest request = new DescribeVpcsRequest();\n        List\u003cString\u003e list = new ArrayList\u003c\u003e();\n        list.add(\"vpc-13fpdgwk7rxfk3n6nu44wisg7\");\n        request.setVpcIds(list);\n        try {\n            DescribeVpcsResponse response = vpcApi.describeVpcs(request);\n            System.out.println(response);\n        } catch (ApiException e) {\n            System.out.println(e.getResponseBody());\n        }\n    }\n}\n\n```\n\n更多代码示例请参考：[SDK接入文档](./SDK_Integration_zh.md)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvolcengine%2Fvolcengine-java-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvolcengine%2Fvolcengine-java-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvolcengine%2Fvolcengine-java-sdk/lists"}