openstack.identity.version

版本类

版本 (Version) 类继承自 Resource

class openstack.identity.version.Version(_synchronized=False, connection=None, **attrs)

基础资源

参数:
  • _synchronized (bool) – 这不打算直接使用。请参阅 new()existing()

  • connection (openstack.connection.Connection) – 对正在使用的 Connection 的引用。默认为 None,允许在单元测试中等情况下使用不带活动 Connection 的 Resource 对象。Resource 代码中对 self._connection 的使用应自行检查是否为 None。

resource_key = 'version'

资源的单数形式的键。

resources_key = 'versions'

资源的复数形式的键。

base_path = '/'

此资源的 URI 的基本部分。

allow_list = True

允许对此资源进行列表操作。

classmethod list(session, paginated=False, base_path=None, **params)

此方法是一个生成器,它产生资源对象。

此资源对象列表生成器处理分页并接受查询参数以进行响应过滤。

参数:
  • session (Adapter) – 用于发出此请求的会话。

  • paginated (bool) – 如果对该资源的 GET 返回分页响应序列,则为 True,否则如果 GET 只返回一页数据,则为 False。**当 paginated 为 False 时,无论 API 是否支持分页,都将只返回一页数据。**

  • base_path (str) – 如果与 base_path 不同,则为列出资源 URI 的基本部分。

  • allow_unknown_params (bool) – 如果设置为 True,则接受但丢弃未知的查询参数。这允许获取“filters”列表并将所有已知内容传递给服务器。将 False 导致在传递未知查询参数时发生验证异常。

  • microversion (str) – 覆盖协商版本使用的 API 版本。

  • headers (dict) – 要注入到 HTTP 请求中的其他标头。

  • max_items (int) – 要返回的最大项目数。通常,这必须与 paginated=True 一起使用。

  • params (dict) – 这些关键字参数将通过 _transpose() 方法传递,以查找其中任何一个是否与要发送到 get()params 参数中的预期查询参数匹配。 它们还会针对 base_path 格式字符串进行检查,以查看此参数的内容是否需要填充任何路径片段。 服务器端支持作为筛选器使用的参数将传递到 API 调用中,其余参数将应用于检索结果的筛选器。

返回值:

一个 Resource 对象生成器。

引发:

MethodNotSupported 如果 Resource.allow_list 未设置为 True

引发:

InvalidResourceQuery 如果查询包含无效参数。