Skip to content

Commit bd82afb

Browse files
xuyaming0800xuyaming0800
committed
feat: for ecs 3.7.1
1 parent cb6b6a4 commit bd82afb

File tree

13 files changed

+238
-72
lines changed

13 files changed

+238
-72
lines changed

‎README.md‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# Volcstack SDK for Java
2+
3+
## Table of Contents
4+
* Requirements
5+
* Usage
6+
* API Dosc
7+
* Note
8+
9+
### Requirements ###
10+
运行 SDK需要jdk **Java 1.6+**. 你可以下载最新的版本： http://developers.sun.com/downloads/.
11+
如果 SDK版本 高于或者等于 **Java 9** 请依赖javax.annotation-api
12+
由于在高于或者等于 **Java 9** 中 javax.annotation-api 被移除
13+
14+
请在使用中引用
15+
```xml
16+
<dependency>
17+
<groupId>javax.annotation</groupId>
18+
<artifactId>javax.annotation-api</artifactId>
19+
<version>1.3.2</version>
20+
</dependency>
21+
```
22+
23+
### Usage ###
24+
* Getting Started
25+
* Example
26+
27+
#### Getting Started ####
28+
29+
##### 工程使用sdk #####
30+
31+
建议使用Maven构建自己的项目，添加需要的相应模块的依赖，示例如下：
32+
33+
##### Importing the pom #####
34+
35+
```xml
36+
<dependencyManagement>
37+
<dependencies>
38+
<dependency>
39+
<groupId>com.volcengine.volcstack</groupId>
40+
<artifactId>volcstack-java-sdk-bom</artifactId>
41+
<version>0.1.0</version>
42+
<type>pom</type>
43+
<scope>import</scope>
44+
</dependency>
45+
</dependencies>
46+
</dependencyManagement>
47+
```
48+
49+
50+
##### Using the SDK Maven modules #####
51+
52+
```xml
53+
<dependencies>
54+
<dependency>
55+
<groupId>com.volcengine.volcstack</groupId>
56+
<artifactId>volcstack-java-sdk-vpc</artifactId>
57+
<version>0.1.0</version>
58+
</dependency>
59+
<dependency>
60+
<groupId>com.volcengine.volcstack</groupId>
61+
<artifactId>volcstack-java-sdk-ecs</artifactId>
62+
<version>0.1.0</version>
63+
</dependency>
64+
</dependencies>
65+
```
66+
67+
##### Credentials 配置 #####
68+
69+
**通过环境变量导入**:
70+
```
71+
export VOLCSTACK_ACCESS_KEY=your ak
72+
export VOLCSTACK_SECRET_KEY=your sk
73+
#如果使用token
74+
export VOLCSTACK_SESSION_TOKEN=token
75+
```
76+
77+
**代码方式引入**：
78+
79+
```java
80+
Credentials credentials = Credentials.getCredentials(ak,sk);
81+
//如果使用token
82+
Credentials credentials = Credentials.getCredentials(ak,sk，token);
83+
```
84+
85+
#### Example ####
86+
```java
87+
import com.volcengine.volcstack.ApiClient;
88+
import com.volcengine.volcstack.ApiException;
89+
import com.volcengine.volcstack.sign.Credentials;
90+
import com.volcengine.volcstack.vpc.VpcApi;
91+
import com.volcengine.volcstack.vpc.model.DescribeVpcsRequest;
92+
import com.volcengine.volcstack.vpc.model.DescribeVpcsResponse;
93+
94+
import java.util.ArrayList;
95+
import java.util.List;
96+
97+
public class TestVpc {
98+
public static void main(String[] args)throws Exception {
99+
String ak = "your ak";
100+
String sk = "your sk";
101+
String region = "cn-beijing";
102+
103+
ApiClient apiClient = new ApiClient()
104+
.setCredentials(Credentials.getCredentials(ak,sk))
105+
.setRegion(region);
106+
VpcApi vpcApi = new VpcApi(apiClient);
107+
DescribeVpcsRequest request = new DescribeVpcsRequest();
108+
List<String> list = new ArrayList<>();
109+
list.add("vpc-13fpdgwk7rxfk3n6nu44wisg7");
110+
request.setVpcIds(list);
111+
try {
112+
DescribeVpcsResponse response = vpcApi.describeVpcs(request);
113+
System.out.println(response);
114+
} catch (ApiException e) {
115+
System.out.println(e.getResponseBody());
116+
}
117+
}
118+
}
119+
120+
```

‎pom.xml‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<groupId>com.volcengine.volcstack</groupId>
88
<artifactId>volcstack-java-sdk</artifactId>
99
<packaging>pom</packaging>
10-
<version>0.1.0-SNAPSHOT</version>
10+
<version>0.1.0</version>
1111

1212

1313
<properties>
@@ -82,14 +82,12 @@
8282

8383
<distributionManagement>
8484
<snapshotRepository>
85-
<id>snapshots</id>
86-
<name>volcstack-java-sdk</name>
87-
<url>http://10.248.191.104:8081/nexus/repository/maven-snapshots/</url>
85+
<id>ossrh</id>
86+
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
8887
</snapshotRepository>
8988
<repository>
90-
<id>releases</id>
91-
<name>volcstack-java-sdk</name>
92-
<url>http://10.248.191.104:8081/nexus/repository/maven-releases/</url>
89+
<id>ossrh</id>
90+
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
9391
</repository>
9492
</distributionManagement>
9593

@@ -136,6 +134,7 @@
136134
<module>volcstack-java-sdk-storageebs</module>
137135
<module>volcstack-java-sdk-natgateway</module>
138136
<module>volcstack-java-sdk-directconnect</module>
137+
<module>volcstack-java-sdk-bom</module>
139138
</modules>
140139

141140
</project>

‎volcstack-java-sdk-bom/pom.xml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<project xmlns="http://maven.apache.org/POM/4.0.0"
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5+
<parent>
6+
<artifactId>volcstack-java-sdk</artifactId>
7+
<groupId>com.volcengine.volcstack</groupId>
8+
<version>0.1.0</version>
9+
<relativePath>../pom.xml</relativePath>
10+
</parent>
11+
<modelVersion>4.0.0</modelVersion>
12+
13+
<artifactId>volcstack-java-sdk-bom</artifactId>
14+
<packaging>pom</packaging>
15+
<name>VOLCSTACK SDK for Java - BOM</name>
16+
<description>The VOLCSTACK SDK for Java - BOM module holds the dependency mangements for individual java clients.</description>
17+
18+
<dependencyManagement>
19+
<dependencies>
20+
<dependency>
21+
<groupId>com.volcengine.volcstack</groupId>
22+
<artifactId>volcstack-java-sdk-core</artifactId>
23+
<optional>false</optional>
24+
<version>${project.version}</version>
25+
</dependency>
26+
<dependency>
27+
<groupId>com.volcengine.volcstack</groupId>
28+
<artifactId>volcstack-java-sdk-cen</artifactId>
29+
<optional>false</optional>
30+
<version>${project.version}</version>
31+
</dependency>
32+
<dependency>
33+
<groupId>com.volcengine.volcstack</groupId>
34+
<artifactId>volcstack-java-sdk-clb</artifactId>
35+
<optional>false</optional>
36+
<version>${project.version}</version>
37+
</dependency>
38+
<dependency>
39+
<groupId>com.volcengine.volcstack</groupId>
40+
<artifactId>volcstack-java-sdk-directconnect</artifactId>
41+
<optional>false</optional>
42+
<version>${project.version}</version>
43+
</dependency>
44+
<dependency>
45+
<groupId>com.volcengine.volcstack</groupId>
46+
<artifactId>volcstack-java-sdk-ecs</artifactId>
47+
<optional>false</optional>
48+
<version>${project.version}</version>
49+
</dependency>
50+
<dependency>
51+
<groupId>com.volcengine.volcstack</groupId>
52+
<artifactId>volcstack-java-sdk-natgateway</artifactId>
53+
<optional>false</optional>
54+
<version>${project.version}</version>
55+
</dependency>
56+
<dependency>
57+
<groupId>com.volcengine.volcstack</groupId>
58+
<artifactId>volcstack-java-sdk-storageebs</artifactId>
59+
<optional>false</optional>
60+
<version>${project.version}</version>
61+
</dependency>
62+
<dependency>
63+
<groupId>com.volcengine.volcstack</groupId>
64+
<artifactId>volcstack-java-sdk-vpc</artifactId>
65+
<optional>false</optional>
66+
<version>${project.version}</version>
67+
</dependency>
68+
<dependency>
69+
<groupId>com.volcengine.volcstack</groupId>
70+
<artifactId>volcstack-java-sdk-vpn</artifactId>
71+
<optional>false</optional>
72+
<version>${project.version}</version>
73+
</dependency>
74+
</dependencies>
75+
</dependencyManagement>
76+
</project>

‎volcstack-java-sdk-cen/pom.xml‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,13 @@
55
<parent>
66
<artifactId>volcstack-java-sdk</artifactId>
77
<groupId>com.volcengine.volcstack</groupId>
8-
<version>0.1.0-SNAPSHOT</version>
8+
<version>0.1.0</version>
9+
<relativePath>../pom.xml</relativePath>
910
</parent>
1011
<modelVersion>4.0.0</modelVersion>
1112

1213
<artifactId>volcstack-java-sdk-cen</artifactId>
1314

14-
<properties>
15-
<maven.compiler.source>11</maven.compiler.source>
16-
<maven.compiler.target>11</maven.compiler.target>
17-
</properties>
18-
1915
<dependencies>
2016
<dependency>
2117
<groupId>com.volcengine.volcstack</groupId>

‎volcstack-java-sdk-clb/pom.xml‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,13 @@
55
<parent>
66
<artifactId>volcstack-java-sdk</artifactId>
77
<groupId>com.volcengine.volcstack</groupId>
8-
<version>0.1.0-SNAPSHOT</version>
8+
<version>0.1.0</version>
9+
<relativePath>../pom.xml</relativePath>
910
</parent>
1011
<modelVersion>4.0.0</modelVersion>
1112

1213
<artifactId>volcstack-java-sdk-clb</artifactId>
1314

14-
<properties>
15-
<maven.compiler.source>11</maven.compiler.source>
16-
<maven.compiler.target>11</maven.compiler.target>
17-
</properties>
18-
1915
<dependencies>
2016
<dependency>
2117
<groupId>com.volcengine.volcstack</groupId>

‎volcstack-java-sdk-core/pom.xml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
<parent>
66
<groupId>com.volcengine.volcstack</groupId>
77
<artifactId>volcstack-java-sdk</artifactId>
8-
<version>0.1.0-SNAPSHOT</version>
8+
<version>0.1.0</version>
9+
<relativePath>../pom.xml</relativePath>
910
</parent>
1011
<modelVersion>4.0.0</modelVersion>
1112

‎volcstack-java-sdk-directconnect/pom.xml‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,13 @@
55
<parent>
66
<artifactId>volcstack-java-sdk</artifactId>
77
<groupId>com.volcengine.volcstack</groupId>
8-
<version>0.1.0-SNAPSHOT</version>
8+
<version>0.1.0</version>
9+
<relativePath>../pom.xml</relativePath>
910
</parent>
1011
<modelVersion>4.0.0</modelVersion>
1112

1213
<artifactId>volcstack-java-sdk-directconnect</artifactId>
1314

14-
<properties>
15-
<maven.compiler.source>11</maven.compiler.source>
16-
<maven.compiler.target>11</maven.compiler.target>
17-
</properties>
18-
1915
<dependencies>
2016
<dependency>
2117
<groupId>com.volcengine.volcstack</groupId>

‎volcstack-java-sdk-ecs/pom.xml‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,13 @@
55
<parent>
66
<artifactId>volcstack-java-sdk</artifactId>
77
<groupId>com.volcengine.volcstack</groupId>
8-
<version>0.1.0-SNAPSHOT</version>
8+
<version>0.1.0</version>
9+
<relativePath>../pom.xml</relativePath>
910
</parent>
1011
<modelVersion>4.0.0</modelVersion>
1112

1213
<artifactId>volcstack-java-sdk-ecs</artifactId>
1314

14-
<properties>
15-
<maven.compiler.source>11</maven.compiler.source>
16-
<maven.compiler.target>11</maven.compiler.target>
17-
</properties>
1815

1916
<dependencies>
2017
<dependency>

‎volcstack-java-sdk-natgateway/pom.xml‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,13 @@
55
<parent>
66
<artifactId>volcstack-java-sdk</artifactId>
77
<groupId>com.volcengine.volcstack</groupId>
8-
<version>0.1.0-SNAPSHOT</version>
8+
<version>0.1.0</version>
9+
<relativePath>../pom.xml</relativePath>
910
</parent>
1011
<modelVersion>4.0.0</modelVersion>
1112

1213
<artifactId>volcstack-java-sdk-natgateway</artifactId>
1314

14-
<properties>
15-
<maven.compiler.source>11</maven.compiler.source>
16-
<maven.compiler.target>11</maven.compiler.target>
17-
</properties>
18-
1915
<dependencies>
2016
<dependency>
2117
<groupId>com.volcengine.volcstack</groupId>

‎volcstack-java-sdk-storageebs/pom.xml‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,13 @@
55
<parent>
66
<artifactId>volcstack-java-sdk</artifactId>
77
<groupId>com.volcengine.volcstack</groupId>
8-
<version>0.1.0-SNAPSHOT</version>
8+
<version>0.1.0</version>
9+
<relativePath>../pom.xml</relativePath>
910
</parent>
1011
<modelVersion>4.0.0</modelVersion>
1112

1213
<artifactId>volcstack-java-sdk-storageebs</artifactId>
1314

14-
<properties>
15-
<maven.compiler.source>11</maven.compiler.source>
16-
<maven.compiler.target>11</maven.compiler.target>
17-
</properties>
18-
1915
<dependencies>
2016
<dependency>
2117
<groupId>com.volcengine.volcstack</groupId>

0 commit comments

Comments
 (0)