专线网关
获取Endpoint
在确认您使用SDK配置Endpoint时,可先阅读开发人员指南中关于 VPC服务域名的部分,理解Endpoint相关的概念。 百度智能云目前开放了多区域支持,请参考区域选择说明中网络产品VPC的部分,专线网关服务是VPC服务的一部分,使用VPC服务域名。
获取AK/SK
要使用百度云产品,您需要拥有一个百度云账号和一个有效的 AK(Access Key ID)、SK(Secret Access Key)用来进行签名认证。可以通过如下步骤获得并了解您的AK/SK信息:
新建EtGatewayClient
EtGatewayClient是专线网关服务的客户端,为开发者与专线网关服务进行交互提供了一系列的方法。新建EtGatewayClient时,需要先使用Endpoint、AK、SK对EtGatewayClientConfiguration类型的config实例进行配置,再使用config实例对EtGatewayClient进行配置,具体配置方法如下:
1static final String HOST = "";
2static final String AK = "";
3static final String SK = "";
4EtGatewayClientConfiguration config = new EtGatewayClientConfiguration();
5config.setCredentials(new DefaultBceCredentials(ak, sk));
6config.setEndpoint(endpoint);
7EtGatewayClient etGatewayClient = new EtGatewayClient(config);
创建专线网关
函数声明
1public CreateEtGatewayResponse createEtGateway(CreateEtGatewayRequest request) {
2 ......
3}
参数含义
请参考OpenAPI文档:创建专线网关请求参数
返回值
- 操作成功
1{
2 "metadata":具体信息参考附录metadata部分,
3 "etGatewayId": "dcgw-4ds9x3kmds88"
4}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:ExampleCreateEtGateway.java
查询专线网关列表
函数声明
1public ListEtGatewayResponse listEtGateways(ListEtGatewayRequest request) {
2 ......
3}
参数含义
请参考OpenAPI文档:查询专线网关列表请求参数
返回值
- 操作成功
1{
2 "metadata":具体信息参考附录metadata部分,
3 "marker":"dcgw-4ds9x3kmds88",
4 "isTruncated": true,
5 "nextMarker": "dcgw-bi72s924x5xu",
6 "maxKeys": 1,
7 "etGateways":[
8 {
9 "etGatewayId": "dcgw-4ds9x3kmds88",
10 "name": "dcGateway",
11 "status": "running",
12 "speed": 100,
13 "createTime": "2016-03-08T08:13:09Z",
14 "description": "",
15 "vpcId": "vpc-IyrqYIQ7",
16 "etId": "dcphy-478px3km77dh",
17 "channelId": "dedicatedconn-i7c1skfd0djs",
18 "localCidrs": ["192.168.0.0/20"],
19 "enableIpv6": 1,
20 "ipv6LocalCidrs": ["2400:da00:e003:0:15f::/87"]
21 }
22 ]
23}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:ExampleListEtGateways.java
查询专线网关详情
函数声明
1public GetEtGatewayResponse getEtGateway(String etGatewayId) {
2 ......
3}
参数含义
请参考OpenAPI文档:查询专线网关详情请求参数
返回值
- 操作成功
1{
2 "metadata":具体信息参考附录metadata部分,
3 "etGatewayId":"dcgw-4ds9x3kmds88",
4 "name":"dcGateway",
5 "status":"running",
6 "speed":100,
7 "createTime":"2016-03-08T08:13:09Z",
8 "description":"",
9 "vpcId":"vpc-IyrqYIQ7",
10 "etId":"dcphy-478px3km77dh",
11 "channelId":"dedicatedconn-i7c1skfd0djs",
12 "localCidrs":["192.168.0.0/20"],
13 "enableIpv6": 1,
14 "ipv6LocalCidrs": ["2400:da00:e003:0:15f::/87"],
15 "healthCheckSourceIp":"192.168.5.2",
16 "healthCheckDestIp":"172.16.2.3",
17 "healthCheckType":"ICMP",
18 "healthCheckInterval":2,
19 "healthThreshold":2,
20 "unhealthThreshold":2
21}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:ExampleGetEtGateway.java
更新专线网关
函数声明
1public void updateEtGateway(UpdateEtGatewayRequest request) {
2 ......
3}
参数含义
请参考OpenAPI文档:更新专线网关请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:ExampleUpdateEtGateway.java
专线网关绑定物理专线
函数声明
1public void bindEtChannel(BindEtChannelRequest request) {
2 ......
3}
参数含义
请参考OpenAPI文档:专线网关绑定物理专线请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:ExampleBindEtChannel.java
专线网关解绑物理专线
函数声明
1public void unbindEtChannel(UnbindEtChannelRequest request) {
2 ......
3}
参数含义
请参考OpenAPI文档:专线网关解绑物理专线请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:ExampleUnbindEtChannel.java
创建专线网关健康检查
函数声明
1public void createEtGatewayHealthCheck(CreateEtGatewayHealthCheckRequest request) {
2 ......
3}
参数含义
请参考OpenAPI文档:创建专线网关健康检查请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:ExampleCreateEtGatewayHealthCheck.java
释放专线网关
函数声明
1// 不指定clientToken删除专线网关,不支持幂等
2public void deleteEtGateway(String etGatewayId) {
3 ......
4}
5// 指定clientToken删除专线网关,支持幂等
6public void deleteEtGateway(String etGatewayId, String clientToken) {
7 ......
8}
参数含义
请参考OpenAPI文档:释放专线网关请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:ExampleDeleteEtGateway.java
附录
公共返回信息metadata格式
1 {
2 "bceRequestId":"f5f0821d-45fe-439b-bbf4-fc48b639f84a",
3 "contentLength":28,
4 "contentType":"application/json;charset=UTF-8",
5 "date":1701917695000,
6 "server":"openresty/1.15.8.1"
7 }