专线
专线服务
概述
本文档主要介绍ET Python SDK的使用。在使用本文档前,您需要先了解专线的一些基本知识,并已开通了专线服务。若您还不了解专线,可以参考产品描述和操作指南。
初始化
获取Endpoint
在确认您使用SDK配置Endpoint时,可先阅读开发人员指南中关于 ET服务域名的部分,理解Endpoint相关的概念。 百度智能云目前开放了多区域支持,请参考区域选择说明。
目前支持“华北-北京”、“华南-广州”、“华东-苏州”、“香港”、“金融华中-武汉”和“华北-保定”六个区域。对应信息为:
访问区域 | 对应Endpoint | 协议 |
---|---|---|
BJ | bcc.bj.baidubce.com | HTTP and HTTPS |
GZ | bcc.gz.baidubce.com | HTTP and HTTPS |
SU | bcc.su.baidubce.com | HTTP and HTTPS |
HKG | bcc.hkg.baidubce.com | HTTP and HTTPS |
FWH | bcc.fwh.baidubce.com | HTTP and HTTPS |
BD | bcc.bd.baidubce.com | HTTP and HTTPS |
获取密钥
要使用百度云ET,您需要拥有一个有效的AK(Access Key ID)和SK(Secret Access Key)用来进行签名认证。AK/SK是由系统分配给用户的,均为字符串,用于标识用户,为访问ET做签名验证。
可以通过如下步骤获得并了解您的AK/SK信息:
新建ET Client
新建et_client时,需要先使用Endpoint、AK、SK对BceClientConfiguration类型config实例进行配置,再使用config实例对et_client进行配置,具体配置方法如下:
1 HOST = b''
2 AK = b''
3 SK = b''
4 config = BceClientConfiguration(
5 credentials=BceCredentials(AK, SK), endpoint=HOST)
6 self.client = et_client.EtClient(config)
ET
申请物理专线
函数声明
1def create_et_dcphy(self, name, isp, intf_type, ap_type, ap_addr, user_name, user_phone,
2 user_email, user_idc, client_token=None, description=None, config=None):
参数说明
请参考OpenAPI文档:申请物理专线参数说明
返回值
- 操作成功
1{
2 "id": "dcphy-gq65bz9ip712"
3}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_create_et.py
查询专线列表
函数声明
1def list_et_dcphy(self, status=None, marker=None, max_keys=1000, config=None):
参数说明
请参考OpenAPI文档:查询专线列表参数说明
返回值
- 操作成功
1{
2 "nextMarker": "dcphy-gq65bz9ip712",
3 "marker": "dcphy-gq65bz9ie712",
4 "maxKeys": 1,
5 "isTruncated": true,
6 "ets": [{
7 "id": "dcphy-jy1sbnx32ez0",
8 "name": "et_6",
9 "description": "描述",
10 "status": "established",
11 "expireTime": "2019-01-30T08:50:00Z",
12 "isp": "ISP_CTC",
13 "intfType": "10G",
14 "apType": "BAIDU",
15 "apAddr": "BB",
16 "userName": "张三",
17 "userPhone": "133*****333",
18 "userEmail": "1***@123.com",
19 "userIdc": "北京|市辖区|东城区|2321"
20 }]
21}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_list_et.py
查询专线详情
函数声明
1def list_et_dcphy_detail(self, et_id, config=None):
参数说明
请参考OpenAPI文档:查询专线详情参数说明
返回值
- 操作成功
1{
2 "id": "dcphy-gq65bz9ip712",
3 "name": "ZX051501-testET",
4 "description": "",
5 "status": "established",
6 "expireTime": 1,
7 "isp": "ISP_CUCC",
8 "intfType": "10G",
9 "apType": "SINGLE",
10 "apAddr": "WHGG",
11 "userName": "张三",~~~~
12 "userPhone": "133*****333",
13 "userEmail": "1***@123.com",
14 "userIdc": "北京|市辖区|东城区|百度科技园K2"
15}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_list_et_detail.py
更新物理专线
函数声明
1def update_et_dcphy(self, et_id, name=None, description=None, user_name=None,
2 user_phone=None, user_email=None, client_token=None, config=None):
参数说明
请参考OpenAPI文档:更新物理专线参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_update_et.py
新建专线通道
函数声明
1def create_et_channel(self, et_id, local_ip, name, remote_ip, route_type, vlan_id,
2 authorized_users=None, description=None, networks=None,
3 bgp_asn=None, bgp_key=None, enable_ipv6=None, local_ipv6=None,
4 remote_ipv6=None, ipv6_networks=None, client_token=None, config=None):
参数说明
请参考OpenAPI文档:新建专线通道参数说明
返回值
- 操作成功
1 {
2 "id": "dedicatedconn-zy9t7n91k0iq"
3 }
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_create_et_channel.py
查询专线通道
函数声明
1def get_et_channel(self, et_id, client_token=None, config=None):
参数说明
请参考OpenAPI文档:查询专线通道参数说明
返回值
- 操作成功
1 {
2 "etChannels": [
3 {
4 "authorizedUsers": [
5 "8770xxxxxxxxxxxxxxxxxxxxxxxx4df8"
6 ],
7 "description": "",
8 "baiduAddress": "11.11.11.21/24",
9 "name": "channel_name",
10 "networks": [
11 "192.168.0.0/16"
12 ],
13 "customerAddress": "11.11.11.12/24",
14 "routeType": "static-route",
15 "vlanId": 56,
16 "id":"dedicatedconn-zy9t7n91k0iq",
17 "status":"building",
18 "enableIpv6": 1,
19 "baiduIpv6Address": "2400:da00:e003:0:1eb:200::/88",
20 "ipv6Networks": [
21 "2400:da00:e003:0:15f::/87"
22 ],
23 "customerIpv6Address": "2400:da00:e003:0:0:200::/88"
24 }
25 ]
26 }
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_get_et_channel.py
重新提交专线通道
函数声明
1def recommit_et_channel(self, et_id, et_channel_id, local_ip, name, networks, remote_ip, route_type, vlan_id,
2 authorized_users=None, description=None, enable_ipv6=None, local_ipv6=None,
3 remote_ipv6=None, ipv6_networks=None, client_token=None, config=None):
参数说明
请参考OpenAPI文档:重新提交专线通道参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_recommit_et_channel.py
更新专线通道
函数声明
1def update_et_channel(self, et_id, et_channel_id, name=None, description=None, client_token=None, config=None):
参数说明
请参考OpenAPI文档:更新专线通道参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_update_et_channel.py
删除专线通道
函数声明
1def delete_et_channel(self, et_id, et_channel_id, client_token=None, config=None):
参数说明
请参考OpenAPI文档:删除专线通道参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_delete_et_channel.py
打开专线通道的IPv6功能
函数声明
1def enable_et_channel_ipv6(self, et_id, et_channel_id, local_ipv6, remote_ipv6,
2 ipv6_networks=None, client_token=None, config=None):
参数说明
请参考OpenAPI文档:打开专线通道的IPv6功能参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_enable_et_channel_ipv6.py
关闭专线通道的IPv6功能
函数声明
1def disable_et_channel_ipv6(self, et_id, et_channel_id, client_token=None, config=None):
参数含义
请参考OpenAPI文档:关闭专线通道的IPv6功能参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:example_disable_et_channel_ipv6.py
创建专线通道路由规则
函数声明
1def create_et_channel_route_rule(self, et_id, et_channel_id, dest_address, nexthop_type,
2 nexthop_id, description=None, ip_version=4,
3 client_token=None, config=None):
参数含义
请参考OpenAPI文档:创建专线通道路由规则
返回值
- 操作成功
1{
2 "routeRuleId":"dcrr-5afcf643-94e"
3}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:example_create_et_channel_route_rule.py
查询专线通道路由规则
函数声明
1def list_et_channel_route_rules(self, et_id, et_channel_id, marker=None,
2 max_Keys=None, dest_address=None, config=None):
参数含义
请参考OpenAPI文档:查询专线通道路由规则
返回值
- 操作成功
1{
2 "nextMarker": "14eabc99-dce7-11ec-84d4-6c92bf29c398",
3 "maxKeys": 1,
4 "isTruncated": true,
5 "routeRules": [{
6 "routeRuleId": "dcrr-5afcf643-94e",
7 "ipVersion": 4,
8 "destAddress": "10.0.0.1/32",
9 "nexthopType": "etGateway"
10 "nexthopId": "dcgw-arc647h3014w",
11 "description": "route_1"
12 }]
13}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:example_list_et_channel_route_rules.py
修改专线通道路由规则
函数声明
1def update_et_channel_route_rule(self, et_id, et_channel_id, et_channel_route_rule_id,
2 description, client_token=None, config=None):
参数含义
请参考OpenAPI文档:修改专线通道路由规则参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:example_update_et_channel_route_rule.py
删除专线通道路由规则
函数声明
1def delete_et_channel_route_rule(self, et_id, et_channel_id, et_channel_route_rule_id,
2 client_token=None, config=None):
参数含义
请参考OpenAPI文档:删除专线通道路由规则参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码