python3针对zstack进行api接口

XMYX-0

已于 2024-08-28 14:45:22 修改

阅读量367

点赞数 4

文章标签： python zstack

于 2024-08-28 13:25:57 首次发布

本文链接：https://blog.csdn.net/weixin_42434700/article/details/141638358

版权

文章目录

使用 Python 操作 ZStack 云平台 API
完整代码，包含较多信息

使用 Python 操作 ZStack 云平台 API

在现代云计算环境中，自动化和可编程性是关键特性。ZStack 是一个开源的云计算管理软件，它提供了丰富的 API 接口，允许用户通过编程方式管理云资源。在本文中，我们将探讨如何使用 Python 和 requests 库来与 ZStack API 交互，执行如登录、获取云主机信息、重启云主机等常见操作。

官方手册网址

环境准备

首先，确保你的环境中安装了 Python 和 requests 、json 、hashlib 库。你可以通过 pip 安装 requests 、json 、hashlib库：

pip3 install requests
pip3 install json
pip3 install hashlib

此外，你还需要有 ZStack 环境的访问权限，包括主机地址、端口、用户名和密码。

初始化

在初始化时，需要提供以下参数：

host: ZStack API 服务器的 IP 地址或域名
user: 登录 ZStack API 的用户名（默认为 “admin”）
passwd: 登录 ZStack API 的密码（默认为 “password”）
port: ZStack API 服务器的端口号（默认为 8080）

编写 ZStack API 客户端

我们将创建一个 Python 类 ZstackInstancesApi，用于封装与 ZStack API 的交互逻辑。

初始化

在类的初始化方法中，我们设置 ZStack API 的基础 URL，并尝试使用提供的用户名和密码登录。注意，密码需要被加密，这里我们使用 SHA-512 算法进行加密。

import requests
import json
import hashlib

class ZstackInstancesApi(object):
    def __init__(self, host, user="admin", passwd="password", port=8080):
        self.zstack_api_url = f"http://{host}:{port}/zstack/"
        self.login_data = {
            "logInByAccount": {
                "accountName": user,
                "password": hashlib.sha512(passwd.encode()).hexdigest(),
            }
        }
        self.headers = {"Content-Type": "application/json", "charset": "UTF-8"}
        res = requests.put(
            self.zstack_api_url + "v1/accounts/login",
            data=json.dumps(self.login_data),
            headers=self.headers,
        )
        self.session_id = res.json()["inventory"]["uuid"]

获取云主机信息

通过 API 获取指定 UUID 的云主机信息，并返回其控制台地址。

def getinstancevm(self, uuid):
    res = requests.get(
        self.zstack_api_url + f"v1/vm-instances/{uuid}/console-addresses",
        headers={
            "Content-Type": "application/json;charset=UTF-8",
            "Authorization": "OAuth " + self.session_id,
        },
    )
    return res.json()

其他 API 方法

你还可以实现其他方法，如获取所有云主机信息、重启云主机、更新云主机信息、启动和停止云主机等。这些方法都遵循类似的模式：发送 HTTP 请求到 ZStack API，处理响应，并返回结果。

示例使用

现在，你可以创建 ZstackInstancesApi 的实例，并使用它来与 ZStack 交互。以下是一个示例，展示了如何获取指定 L3 网络的信息：

if __name__ == "__main__":
    zstack_api = ZstackInstancesApi(host="192.168.10.1")
    print(zstack_api.get_l3_network("testuuid")) ## 根据自己UUID进行获取，
#    print(zstack_api.get_l3_network("adghjkklldsafasd4e1d8c184e426ffa3fe2"))

请确保将 "10.255.101.249" 替换为你的 ZStack 服务器地址，将 "c3726f15b55e4e1d8c184e426ffa3fe2" 替换为你想要查询的 L3 网络的 UUID。

结论

通过 Python 和 requests 库，我们可以轻松实现与 ZStack API 的交互，从而自动化和管理云资源。本文提供的示例代码展示了如何登录 ZStack、获取云主机和 L3 网络的信息，以及执行其他常见操作。你可以根据自己的需求，进一步扩展这个类，添加更多的 API 方法。

完整代码，包含较多信息

import requests
import json
import hashlib

class ZstackInstancesApi(object):
	# 用户名密码端口
    def __init__(self, host, user="admin", passwd="password", port=8080):
        # 初始化 ZStack API 基础 URL
        self.zstack_api_url = f"http://{host}:{port}/zstack/"
        # 登录信息，使用 SHA-512 对密码进行加密
        self.login_data = {
            "logInByAccount": {
                "accountName": user,
                "password": hashlib.sha512(passwd.encode()).hexdigest(),
            }
        }
        self.headers = {"Content-Type": "application/json", "charset": "UTF-8"}
        # 发送登录请求并保存 session ID
        res = requests.put(
            self.zstack_api_url + "v1/accounts/login",
            data=json.dumps(self.login_data),
            headers=self.headers,
        )
        self.session_id = res.json()["inventory"]["uuid"]

    def getinstancevm(self, uuid):
        """
        获取指定 UUID 的云主机信息
        :param uuid: 云主机的唯一标识符
        :return: 返回云主机的控制台地址信息
        """
        res = requests.get(
            self.zstack_api_url + f"v1/vm-instances/{uuid}/console-addresses",
            headers={
                "Content-Type": "application/json;charset=UTF-8",
                "Authorization": "OAuth " + self.session_id,
            },
        )
        return res.json()

    def get_instances_info(self):
        """
        获取所有云主机的基本信息
        :return: 云主机的 UUID、名称、描述等信息
        """
        res = requests.get(
            self.zstack_api_url + "v1/vm-instances",
            headers={"Authorization": "OAuth " + self.session_id},
        )
        return res.json()["inventories"]

    def reboot_instance(self, uuid):
        """
        重启指定 UUID 的云主机
        :param uuid: 云主机的唯一标识符
        :return: 返回操作结果
        """
        res = requests.put(
            self.zstack_api_url + f"v1/vm-instances/{uuid}/actions",
            headers={
                "Content-Type": "application/json;charset=UTF-8",
                "Authorization": "OAuth " + self.session_id,
            },
            json={"rebootVmInstance": {}},
        )
        return res.json()

    def update_instance(self, uuid, **args):
        """
        更新云主机信息
        :param uuid: 云主机的唯一标识符
        :param args: 更新的字段，如 name='新名称', description='信息'
        :return: 返回更新操作的结果
        """
        res = requests.put(
            self.zstack_api_url + f"v1/vm-instances/{uuid}/actions",
            headers={
                "Content-Type": "application/json;charset=UTF-8",
                "Authorization": "OAuth " + self.session_id,
            },
            json={"updateVmInstance": args},
        )
        return res.json()

    def start_instance(self, uuid):
        """
        启动指定 UUID 的云主机
        :param uuid: 云主机的唯一标识符
        :return: 返回操作结果
        """
        res = requests.put(
            self.zstack_api_url + f"v1/vm-instances/{uuid}/actions",
            headers={
                "Content-Type": "application/json;charset=UTF-8",
                "Authorization": "OAuth " + self.session_id,
            },
            json={"startVmInstance": {}},
        )
        return res.json()

    def stop_instance(self, uuid):
        """
        关闭指定 UUID 的云主机
        :param uuid: 云主机的唯一标识符
        :return: 返回操作结果
        """
        res = requests.put(
            self.zstack_api_url + f"v1/vm-instances/{uuid}/actions",
            headers={
                "Content-Type": "application/json;charset=UTF-8",
                "Authorization": "OAuth " + self.session_id,
            },
            json={"stopVmInstance": {"type": "grace"}},
        )
        return res.json()

    def zstack_logout(self):
        """
        退出 ZStack 登录
        :return: 返回退出登录的响应结果
        """
        res = requests.delete(
            self.zstack_api_url + "api/v2/session/" + self.session_id,
            headers={"X-ZStack-Session": self.session_id},
        )
        return res

    def resize_instance_disk(self, uuid, size):
        """
        调整云主机磁盘大小
        :param uuid: 磁盘的唯一标识符
        :param size: 新的磁盘大小（以字节为单位）
        :return: 返回调整磁盘大小的结果
        """
        res = requests.put(
            self.zstack_api_url + f"v1/volumes/resize/{uuid}/actions",
            headers={
                "Content-Type": "application/json;charset=UTF-8",
                "Authorization": "OAuth " + self.session_id,
            },
            json={
                "resizeRootVolume": {"size": size},
                "systemTags": [],
                "userTags": [],
            },
        )
        return res.json()

    def get_instance_disk(self, uuid):
        """
        获取指定云主机的磁盘信息
        :param uuid: 云主机的唯一标识符
        :return: 返回磁盘信息
        """
        res = requests.get(
            self.zstack_api_url + f"v1/volumes",
            headers={
                "Content-Type": "application/json;charset=UTF-8",
                "Authorization": "OAuth " + self.session_id,
            },
        )
        return res.json()

    def get_l3_network(self, uuid):
        """
        获取指定 L3 网络的信息
        :param uuid: L3 网络的唯一标识符
        :return: 返回 L3 网络的详细信息
        """
        res = requests.get(
            self.zstack_api_url + f"v1/l3-networks/ip-ranges/{uuid}",
            headers={
                "Content-Type": "application/json;charset=UTF-8",
                "Authorization": "OAuth " + self.session_id,
            },
        )
        return res.json()

    def update_l3_network(self, uuid, data):
        """
        更新 L3 网络信息
        :param uuid: L3 网络的唯一标识符
        :param data: 包含网络更新信息的字典
        :return: 返回更新操作的结果
        """
        res = requests.put(
            self.zstack_api_url + f"v1/l3-networks/ip-ranges/{uuid}/actions",
            headers={
                "Content-Type": "application/json;charset=UTF-8",
                "Authorization": "OAuth " + self.session_id,
            },
            json=data,
        )
        return res.json()


if __name__ == "__main__":
    # 示例：获取指定 L3 网络的信息
    print(
        ZstackInstancesApi(host="192.168.10.1").get_l3_network(
            "c3726f15b5sdafasdf4e1d8c184e426ffa3fe2"
        )
    )
	# 获取所有云计算机信息
    print(ZstackInstancesApi(host="10.255.101.249").get_instances_info())