专线网关
获取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进行配置,具体配置方法如下:
static final String HOST = "";
static final String AK = "";
static final String SK = "";
EtGatewayClientConfiguration config = new EtGatewayClientConfiguration();
config.setCredentials(new DefaultBceCredentials(ak, sk));
config.setEndpoint(endpoint);
EtGatewayClient etGatewayClient = new EtGatewayClient(config);
创建专线网关
函数声明
public CreateEtGatewayResponse createEtGateway(CreateEtGatewayRequest request) {
......
}
参数含义
请参考OpenAPI文档:创建专线网关请求参数
返回值
- 操作成功
{
"metadata":具体信息参考附录metadata部分,
"etGatewayId": "dcgw-4ds9x3kmds88"
}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:ExampleCreateEtGateway.java
查询专线网关列表
函数声明
public ListEtGatewayResponse listEtGateways(ListEtGatewayRequest request) {
......
}
参数含义
请参考OpenAPI文档:查询专线网关列表请求参数
返回值
- 操作成功
{
"metadata":具体信息参考附录metadata部分,
"marker":"dcgw-4ds9x3kmds88",
"isTruncated": true,
"nextMarker": "dcgw-bi72s924x5xu",
"maxKeys": 1,
"etGateways":[
{
"etGatewayId": "dcgw-4ds9x3kmds88",
"name": "dcGateway",
"status": "running",
"speed": 100,
"createTime": "2016-03-08T08:13:09Z",
"description": "",
"vpcId": "vpc-IyrqYIQ7",
"etId": "dcphy-478px3km77dh",
"channelId": "dedicatedconn-i7c1skfd0djs",
"localCidrs": ["192.168.0.0/20"],
"enableIpv6": 1,
"ipv6LocalCidrs": ["2400:da00:e003:0:15f::/87"]
}
]
}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:ExampleListEtGateways.java
查询专线网关详情
函数声明
public GetEtGatewayResponse getEtGateway(String etGatewayId) {
......
}
参数含义
请参考OpenAPI文档:查询专线网关详情请求参数
返回值
- 操作成功
{
"metadata":具体信息参考附录metadata部分,
"etGatewayId":"dcgw-4ds9x3kmds88",
"name":"dcGateway",
"status":"running",
"speed":100,
"createTime":"2016-03-08T08:13:09Z",
"description":"",
"vpcId":"vpc-IyrqYIQ7",
"etId":"dcphy-478px3km77dh",
"channelId":"dedicatedconn-i7c1skfd0djs",
"localCidrs":["192.168.0.0/20"],
"enableIpv6": 1,
"ipv6LocalCidrs": ["2400:da00:e003:0:15f::/87"],
"healthCheckSourceIp":"192.168.5.2",
"healthCheckDestIp":"172.16.2.3",
"healthCheckType":"ICMP",
"healthCheckInterval":2,
"healthThreshold":2,
"unhealthThreshold":2
}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:ExampleGetEtGateway.java
更新专线网关
函数声明
public void updateEtGateway(UpdateEtGatewayRequest request) {
......
}
参数含义
请参考OpenAPI文档:更新专线网关请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:ExampleUpdateEtGateway.java
专线网关绑定物理专线
函数声明
public void bindEtChannel(BindEtChannelRequest request) {
......
}
参数含义
请参考OpenAPI文档:专线网关绑定物理专线请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:ExampleBindEtChannel.java
专线网关解绑物理专线
函数声明
public void unbindEtChannel(UnbindEtChannelRequest request) {
......
}
参数含义
请参考OpenAPI文档:专线网关解绑物理专线请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:ExampleUnbindEtChannel.java
创建专线网关健康检查
函数声明
public void createEtGatewayHealthCheck(CreateEtGatewayHealthCheckRequest request) {
......
}
参数含义
请参考OpenAPI文档:创建专线网关健康检查请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:ExampleCreateEtGatewayHealthCheck.java
释放专线网关
函数声明
// 不指定clientToken删除专线网关,不支持幂等
public void deleteEtGateway(String etGatewayId) {
......
}
// 指定clientToken删除专线网关,支持幂等
public void deleteEtGateway(String etGatewayId, String clientToken) {
......
}
参数含义
请参考OpenAPI文档:释放专线网关请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:ExampleDeleteEtGateway.java
附录
公共返回信息metadata格式
{
"bceRequestId":"f5f0821d-45fe-439b-bbf4-fc48b639f84a",
"contentLength":28,
"contentType":"application/json;charset=UTF-8",
"date":1701917695000,
"server":"openresty/1.15.8.1"
}