高可用虚拟IP
获取Endpoint
在确认您使用SDK配置Endpoint时,可先阅读开发人员指南中关于VPC服务域名的部分,理解Endpoint相关的概念。 百度智能云目前开放了多区域支持,请参考区域选择说明中网络产品VPC的部分,高可用虚拟IP服务是VPC服务的一部分,使用VPC服务域名。
获取AK/SK
要使用百度云产品,您需要拥有一个百度云账号和一个有效的 AK(Access Key ID)、SK(Secret Access Key)用来进行签名认证。可以通过如下步骤获得并了解您的AK/SK信息: 1. 注册百度云账号 2. 创建AK/SK
新建HaVipClient
新建HaVipClient时,需要先使用Endpoint、AK、SK对HaVipClientConfiguration类型config实例进行配置,再使用config实例对HaVipClient进行配置,配置示例如下:
1ak = b''
2sk = b''
3endpoint = b'bcc.bj.baidubce.com' # Replace with your havip endpoint
4config = BceClientConfiguration(credentials=BceCredentials(access_key_id=ak, secret_access_key=sk),endpoint=endpoint)
5havip_client = havip_client.HavipClient(config)
创建高可用虚拟IP
函数声明
1@required(name=(bytes, str),
2 subnet_id=(bytes, str),
3 private_ip_address=(bytes, str),
4 description=(bytes, str))
5def create_havip(self, name, subnet_id, private_ip_address,
6 description="", client_token=None, version=None,
7 config=None):
参数含义
请参考OpenAPI文档:创建高可用虚拟IP参数说明
返回值
- 操作成功
1{
2 "metadata":具体信息参考附录metadata部分,
3 "haVipId":"havip-w2d4kgc3x0y1"
4}
-
操作失败
操作失败返回异常列表参考:异常列表
代码示例
具体代码示例参考:example_create_havip.py
查询高可用虚拟IP列表
函数声明
1@required(vpc_id=(bytes, str))
2def get_havip_detail_list(self, vpc_id=None, config=None):
3 ....
参数含义
请参考OpenAPI文档:查询高可用虚拟IP列表参数说明
返回值
- 操作成功
1{
2 "haVips":[
3 {
4 "haVipId":"havip-jshdu47sk",
5 "name":"test_havip",
6 "description":"",
7 "vpcId":"vpc-r625rqw3wuer",
8 "subnetId":"sbn-i4d47zb73ztx",
9 "status":"available",
10 "privateIpAddress":"192.168.1.221",
11 "publicIpAddress":"180.76.245.166",
12 "createdTime":"2022-08-31T11:42:19Z"
13 },
14 {
15 "haVipId":"havip-jshdu47sk",
16 "name":"test_havip",
17 "description":"",
18 "vpcId":"vpc-r625rqw3wuer",
19 "subnetId":"sbn-i4d47zb73ztx",
20 "status":"available",
21 "privateIpAddress":"192.168.1.221",
22 "publicIpAddress":"180.76.245.166",
23 "createdTime":"2022-08-31T11:42:19Z"
24 },
25
26 ],
27 is_truncated:False,
28 max_keys:1000,
29 marker:,
30 metadata:具体信息参考附录metadata部分
31}
-
操作失败
操作失败返回异常列表参考:异常列表
代码示例
具体代码示例参考:example_get_havip_detail_list.py
查询指定的高可用虚拟IP
函数声明
1@required(havip_id=(bytes, str))
2def get_havip_detail(self, havip_id, config=None):
3 .....
参数含义
请参考OpenAPI文档:查询指定的高可用虚拟IP参数说明
返回值
- 操作成功
1{
2 "haVipId": "havip-jshdu47sk",
3 "name": "test_havip",
4 "description": "",
5 "vpcId": "vpc-r625rqw3wuer",
6 "subnetId": "sbn-i4d47zb73ztx",
7 "status": "available",
8 "privateIpAddress": "192.168.1.221",
9 "publicIpAddress": "180.76.245.166",
10 "createdTime": "2022-08-31T11:42:19Z",
11 "bindedInstances": [
12 {
13 "instanceId": "eni-w2kmnu1peqxg",
14 "instanceType": "ENI",
15 "master": true
16 },
17 {
18 "instanceId": "eni-7c9yzhkfn9c2",
19 "instanceType": "ENI",
20 "master": false
21 }
22 ],
23 "metadata":具体信息参考附录metadata部分
24}
-
操作失败
操作失败返回异常列表参考:异常列表
代码示例
具体代码示例参考:example_get_havip_detail.py
删除高可用虚拟IP
函数声明
1@required(havip_id=(bytes, str))
2def delete_havip(self, havip_id, client_token=None, config=None):
3 ......
参数含义
请参考OpenAPI文档:删除高可用虚拟IP参数说明
返回值
-
操作成功
无返回值
-
操作失败
操作失败返回异常列表参考:异常列表
代码示例
具体代码示例参考:example_delete_havip.py
更新高可用虚拟IP
函数声明
1@required(name=(bytes, str),
2 havip_id=(bytes, str),
3 description=(bytes, str))
4def update_havip(self, name, havip_id, description="", version=None,
5 client_token=None,
6 config=None):
7 .....
参数含义
请参考OpenAPI文档:更新高可用虚拟IP参数说明
返回值
-
操作成功
无返回值
-
操作失败
操作失败返回异常列表参考:异常列表
代码示例
具体代码示例参考:example_update_havip.py
高可用虚拟IP绑定实例
函数声明
1@required(instance_ids=[(bytes, str)],
2 instance_type=(bytes, str),
3 havip_id=(bytes, str))
4def havip_attach_instance(self, instance_ids, instance_type, havip_id, client_token=None, config=None):
5 ......
参数含义
请参考OpenAPI文档:高可用虚拟IP绑定实例参数说明
返回值
-
操作成功
无返回值
-
操作失败
操作失败返回异常列表参考:异常列表
代码示例
具体代码示例参考:example_havip_attach_instance.py
高可用虚拟IP解绑实例
函数声明
1@required(instance_ids=[(bytes, str)],
2 instance_type=(bytes, str),
3 havip_id=(bytes, str))
4def havip_detach_instance(self, instance_ids, instance_type, havip_id, client_token=None, config=None):
5 ....
参数含义
请参考OpenAPI文档:高可用虚拟IP解绑实例参数说明
返回值
-
操作成功
无返回值
-
操作失败
操作失败返回异常列表参考:异常列表
代码示例
具体代码示例参考:example_havip_detach_instance.py
高可用虚拟IP绑定EIP
1@required(havip_id=(bytes, str),
2 public_ip_address=(bytes, str))
3def havip_bind_public_ip(self, havip_id, public_ip_address, version=None,
4 client_token=None, config=None):
5 ......
参数含义
请参考OpenAPI文档:高可用虚拟IP绑定EIP参数说明
返回值
-
操作成功
无返回值
-
操作失败
操作失败返回异常列表参考:异常列表
代码示例
具体代码示例参考:example_havip_bind_public_ip.py
高可用虚拟IP解绑EIP
函数声明
1@required(havip_id=(bytes, str))
2def havip_unbind_public_ip(self, havip_id, version=None,
3 client_token=None, config=None):
4 ......
参数含义
请参考OpenAPI文档:高可用虚拟IP解绑EIP参数说明
返回值
-
操作成功
无返回值
-
操作失败
操作失败返回异常列表参考:异常列表
代码示例
具体代码示例参考:example_havip_unbind_public_ip.py