高可用虚拟IP

更新时间：2024-01-09

获取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进行配置，配置示例如下：

ak = b''
sk = b''
endpoint = b'bcc.bj.baidubce.com'  # Replace with your havip endpoint
config = BceClientConfiguration(credentials=BceCredentials(access_key_id=ak, secret_access_key=sk),endpoint=endpoint)
havip_client = havip_client.HavipClient(config)

创建高可用虚拟IP

函数声明

@required(name=(bytes, str),
          subnet_id=(bytes, str),
          private_ip_address=(bytes, str),
          description=(bytes, str))
def create_havip(self, name, subnet_id, private_ip_address,
                 description="", client_token=None, version=None,
                 config=None):

参数含义

请参考OpenAPI文档：创建高可用虚拟IP参数说明

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "haVipId":"havip-w2d4kgc3x0y1"
}

操作失败

操作失败返回异常列表参考：异常列表

代码示例

具体代码示例参考：example_create_havip.py

查询高可用虚拟IP列表

函数声明

@required(vpc_id=(bytes, str))
def get_havip_detail_list(self, vpc_id=None, config=None):
    ....

参数含义

请参考OpenAPI文档：查询高可用虚拟IP列表参数说明

返回值

操作成功

{
    "haVips":[
        {
            "haVipId":"havip-jshdu47sk",
            "name":"test_havip",
            "description":"",
            "vpcId":"vpc-r625rqw3wuer",
            "subnetId":"sbn-i4d47zb73ztx",
            "status":"available",
            "privateIpAddress":"192.168.1.221",
            "publicIpAddress":"180.76.245.166",
            "createdTime":"2022-08-31T11:42:19Z"
        },
        {
            "haVipId":"havip-jshdu47sk",
            "name":"test_havip",
            "description":"",
            "vpcId":"vpc-r625rqw3wuer",
            "subnetId":"sbn-i4d47zb73ztx",
            "status":"available",
            "privateIpAddress":"192.168.1.221",
            "publicIpAddress":"180.76.245.166",
            "createdTime":"2022-08-31T11:42:19Z"
        },
        
    ],
    is_truncated:False,
    max_keys:1000,
    marker:,
    metadata:具体信息参考附录metadata部分
}

操作失败

操作失败返回异常列表参考：异常列表

代码示例

具体代码示例参考：example_get_havip_detail_list.py

查询指定的高可用虚拟IP

函数声明

@required(havip_id=(bytes, str))
def get_havip_detail(self, havip_id, config=None):
    .....

参数含义

请参考OpenAPI文档：查询指定的高可用虚拟IP参数说明

返回值

操作成功

{
    "haVipId": "havip-jshdu47sk",
    "name": "test_havip",
    "description": "",
    "vpcId": "vpc-r625rqw3wuer",
    "subnetId": "sbn-i4d47zb73ztx",
    "status": "available",
    "privateIpAddress": "192.168.1.221",
    "publicIpAddress": "180.76.245.166",
    "createdTime": "2022-08-31T11:42:19Z",
    "bindedInstances": [
        {
            "instanceId": "eni-w2kmnu1peqxg",
            "instanceType": "ENI",
            "master": true
        },
        {
            "instanceId": "eni-7c9yzhkfn9c2",
            "instanceType": "ENI",
            "master": false
        }
    ],
    "metadata":具体信息参考附录metadata部分
}

操作失败

操作失败返回异常列表参考：异常列表

代码示例

具体代码示例参考：example_get_havip_detail.py

删除高可用虚拟IP

函数声明

@required(havip_id=(bytes, str))
def delete_havip(self, havip_id, client_token=None, config=None):
    ......

参数含义

请参考OpenAPI文档：删除高可用虚拟IP参数说明

返回值

操作成功

无返回值
操作失败

操作失败返回异常列表参考：异常列表

代码示例

具体代码示例参考：example_delete_havip.py

更新高可用虚拟IP

函数声明

@required(name=(bytes, str),
          havip_id=(bytes, str),
          description=(bytes, str))
def update_havip(self, name, havip_id, description="", version=None,
                 client_token=None,
                 config=None):
    .....

参数含义

请参考OpenAPI文档：更新高可用虚拟IP参数说明

返回值

操作成功

无返回值
操作失败

操作失败返回异常列表参考：异常列表

代码示例

具体代码示例参考：example_update_havip.py