使用 OpenStack SDK¶
本文档的这一部分适用于希望在自己的应用程序中使用此 SDK 的用户。如果您正在寻找有关如何为 SDK 贡献或扩展的文档,请参阅 贡献者 部分。
有关 SDK 中使用的术语列表,包括其支持的项目和服务的名称,请参阅 词汇表。
用户指南¶
这些指南将引导您如何使用我们提供的库来与每个 OpenStack 服务进行交互。如果您正在寻找一种 cookbook 式的方法,那么您应该从这里开始。
测试¶
SDK 提供了一些实用程序来帮助您测试您的应用程序。
API 文档¶
服务 API 通过两层方法公开。通过我们的Connection接口暴露的类是您作为应用程序开发人员使用 OpenStack 云的起点。Resource接口是Connection构建的基础层,Connection方法接受和返回Resource对象。
云抽象层具有数据模型。
Connection 接口¶
一个Connection实例维护您的云配置、会话和身份验证信息,为您提供一组高级接口来与 OpenStack 服务进行交互。
一旦您拥有一个Connection实例,就可以通过 Proxy 或其子类的实例访问服务,这些实例作为 Connection 的属性存在。
服务代理¶
以下服务代理存在于 Connection 上。服务代理始终存在于 Connection 对象上,但是您的 CloudRegion 以及云的目录控制着可以使用哪些服务。
Resource 接口¶
Resource层是与 OpenStack 服务通信的较低级别接口。虽然通过Connection暴露的类在此基础上构建了一个便利层,但Resources可以直接使用。但是,此层最常见的用法是从Connection层中的类接收对象,对其进行修改,然后将其发送回Connection层,例如在服务器上更新资源。
以下服务暴露了Resource类。
低级类¶
以下类通常不被应用程序开发人员使用,但用于构建应用程序与 OpenStack API 进行通信。通常这些部分通过 Connection 接口进行管理,但其使用可以自定义。
错误和警告¶
SDK 尝试为诸如请求失败、API 已弃用和配置无效之类的事情提供详细的错误和警告。应用程序开发人员负责处理这些错误,并且可以选择加入警告以确保其应用程序保持最新。