专线
专线服务
概述
本文档主要介绍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进行配置,具体配置方法如下:
HOST = b''
AK = b''
SK = b''
config = BceClientConfiguration(
credentials=BceCredentials(AK, SK), endpoint=HOST)
self.client = et_client.EtClient(config)
ET
申请物理专线
函数声明
def create_et_dcphy(self, name, isp, intf_type, ap_type, ap_addr, user_name, user_phone,
user_email, user_idc, client_token=None, description=None, config=None):
参数说明
请参考OpenAPI文档:申请物理专线参数说明
返回值
- 操作成功
{
"id": "dcphy-gq65bz9ip712"
}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_create_et.py
查询专线列表
函数声明
def list_et_dcphy(self, status=None, marker=None, max_keys=1000, config=None):
参数说明
请参考OpenAPI文档:查询专线列表参数说明
返回值
- 操作成功
{
"nextMarker": "dcphy-gq65bz9ip712",
"marker": "dcphy-gq65bz9ie712",
"maxKeys": 1,
"isTruncated": true,
"ets": [{
"id": "dcphy-jy1sbnx32ez0",
"name": "et_6",
"description": "描述",
"status": "established",
"expireTime": "2019-01-30T08:50:00Z",
"isp": "ISP_CTC",
"intfType": "10G",
"apType": "BAIDU",
"apAddr": "BB",
"userName": "张三",
"userPhone": "133*****333",
"userEmail": "1***@123.com",
"userIdc": "北京|市辖区|东城区|2321"
}]
}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_list_et.py
查询专线详情
函数声明
def list_et_dcphy_detail(self, et_id, config=None):
参数说明
请参考OpenAPI文档:查询专线详情参数说明
返回值
- 操作成功
{
"id": "dcphy-gq65bz9ip712",
"name": "ZX051501-testET",
"description": "",
"status": "established",
"expireTime": 1,
"isp": "ISP_CUCC",
"intfType": "10G",
"apType": "SINGLE",
"apAddr": "WHGG",
"userName": "张三",~~~~
"userPhone": "133*****333",
"userEmail": "1***@123.com",
"userIdc": "北京|市辖区|东城区|百度科技园K2"
}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_list_et_detail.py
更新物理专线
函数声明
def update_et_dcphy(self, et_id, name=None, description=None, user_name=None,
user_phone=None, user_email=None, client_token=None, config=None):
参数说明
请参考OpenAPI文档:更新物理专线参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_update_et.py
新建专线通道
函数声明
def create_et_channel(self, et_id, local_ip, name, remote_ip, route_type, vlan_id,
authorized_users=None, description=None, networks=None,
bgp_asn=None, bgp_key=None, enable_ipv6=None, local_ipv6=None,
remote_ipv6=None, ipv6_networks=None, client_token=None, config=None):
参数说明
请参考OpenAPI文档:新建专线通道参数说明
返回值
- 操作成功
{
"id": "dedicatedconn-zy9t7n91k0iq"
}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_create_et_channel.py
查询专线通道
函数声明
def get_et_channel(self, et_id, client_token=None, config=None):
参数说明
请参考OpenAPI文档:查询专线通道参数说明
返回值
- 操作成功
{
"etChannels": [
{
"authorizedUsers": [
"8770xxxxxxxxxxxxxxxxxxxxxxxx4df8"
],
"description": "",
"baiduAddress": "11.11.11.21/24",
"name": "channel_name",
"networks": [
"192.168.0.0/16"
],
"customerAddress": "11.11.11.12/24",
"routeType": "static-route",
"vlanId": 56,
"id":"dedicatedconn-zy9t7n91k0iq",
"status":"building",
"enableIpv6": 1,
"baiduIpv6Address": "2400:da00:e003:0:1eb:200::/88",
"ipv6Networks": [
"2400:da00:e003:0:15f::/87"
],
"customerIpv6Address": "2400:da00:e003:0:0:200::/88"
}
]
}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_get_et_channel.py
重新提交专线通道
函数声明
def recommit_et_channel(self, et_id, et_channel_id, local_ip, name, networks, remote_ip, route_type, vlan_id,
authorized_users=None, description=None, enable_ipv6=None, local_ipv6=None,
remote_ipv6=None, ipv6_networks=None, client_token=None, config=None):
参数说明
请参考OpenAPI文档:重新提交专线通道参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_recommit_et_channel.py
更新专线通道
函数声明
def update_et_channel(self, et_id, et_channel_id, name=None, description=None, client_token=None, config=None):
参数说明
请参考OpenAPI文档:更新专线通道参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_update_et_channel.py
删除专线通道
函数声明
def delete_et_channel(self, et_id, et_channel_id, client_token=None, config=None):
参数说明
请参考OpenAPI文档:删除专线通道参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_delete_et_channel.py
打开专线通道的IPv6功能
函数声明
def enable_et_channel_ipv6(self, et_id, et_channel_id, local_ipv6, remote_ipv6,
ipv6_networks=None, client_token=None, config=None):
参数说明
请参考OpenAPI文档:打开专线通道的IPv6功能参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_enable_et_channel_ipv6.py
关闭专线通道的IPv6功能
函数声明
def disable_et_channel_ipv6(self, et_id, et_channel_id, client_token=None, config=None):
参数含义
请参考OpenAPI文档:关闭专线通道的IPv6功能参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:example_disable_et_channel_ipv6.py
创建专线通道路由规则
函数声明
def create_et_channel_route_rule(self, et_id, et_channel_id, dest_address, nexthop_type,
nexthop_id, description=None, ip_version=4,
client_token=None, config=None):
参数含义
请参考OpenAPI文档:创建专线通道路由规则
返回值
- 操作成功
{
"routeRuleId":"dcrr-5afcf643-94e"
}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:example_create_et_channel_route_rule.py
查询专线通道路由规则
函数声明
def list_et_channel_route_rules(self, et_id, et_channel_id, marker=None,
max_Keys=None, dest_address=None, config=None):
参数含义
请参考OpenAPI文档:查询专线通道路由规则
返回值
- 操作成功
{
"nextMarker": "14eabc99-dce7-11ec-84d4-6c92bf29c398",
"maxKeys": 1,
"isTruncated": true,
"routeRules": [{
"routeRuleId": "dcrr-5afcf643-94e",
"ipVersion": 4,
"destAddress": "10.0.0.1/32",
"nexthopType": "etGateway"
"nexthopId": "dcgw-arc647h3014w",
"description": "route_1"
}]
}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:example_list_et_channel_route_rules.py
修改专线通道路由规则
函数声明
def update_et_channel_route_rule(self, et_id, et_channel_id, et_channel_route_rule_id,
description, client_token=None, config=None):
参数含义
请参考OpenAPI文档:修改专线通道路由规则参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:example_update_et_channel_route_rule.py
删除专线通道路由规则
函数声明
def delete_et_channel_route_rule(self, et_id, et_channel_id, et_channel_route_rule_id,
client_token=None, config=None):
参数含义
请参考OpenAPI文档:删除专线通道路由规则参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码