openstack.identity.v2.extension¶
扩展类¶
扩展类 Extension 继承自 Resource。
- class openstack.identity.v2.extension.Extension(_synchronized=False, connection=None, **attrs)¶
基础资源
- 参数:
_synchronized (bool) – 这不打算直接使用。请参阅
new()和existing()。connection (openstack.connection.Connection) – 对正在使用的 Connection 的引用。默认为 None,允许在单元测试中等情况下使用不带活动 Connection 的 Resource 对象。Resource 代码中对
self._connection的使用应使用 None 检查进行保护。
- resource_key = 'extension'¶
资源的单数形式的键。
- resources_key = 'extensions'¶
资源的复数形式的键。
- base_path = '/extensions'¶
此资源的 URI 的基本部分。
- allow_list = True¶
允许对此资源进行列表操作。
- allow_fetch = True¶
允许对此资源进行获取操作。
- alias¶
一个唯一的标识符,将用于通过专用的 URL
/extensions/*alias*访问扩展。扩展别名唯一标识一个扩展,并以供应商标识符为前缀。类型:字符串
- description¶
扩展的描述。类型:字符串
- links¶
指向各种格式文档的链接。类型:字符串
- name¶
扩展的名称。类型:字符串
- namespace¶
扩展的第二个唯一标识符,紧随别名之后。通常是一个将要使用的 URL。例如:“https://docs.openstack.org/identity/api/ext/s3tokens/v1.0” 类型:字符串
- updated_at¶
扩展上次修改的时间(更新日期)。
- 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如果查询包含无效参数。