KeyManager API

有关如何使用密钥管理功能的详细信息,请参阅 使用 OpenStack 密钥管理

KeyManager 类

密钥管理高级接口可通过 Connection 对象的 key_manager 成员访问。只有检测到该服务时,才会添加 key_manager 成员。

密钥操作

class openstack.key_manager.v1._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
create_secret(**attrs)

创建新的密钥

参数:

attrs (dict) – 关键字参数,将用于创建 Secret,包含 Order 类的属性。

返回值:

密钥创建的结果

返回类型:

Secret

delete_secret(secret, ignore_missing=True)

删除密钥

参数:
  • secret – 该值可以是密钥的 ID 或 Secret 实例。

  • ignore_missing (bool) – 如果设置为 False,当密钥不存在时将引发 NotFoundException。如果设置为 True,则在尝试删除不存在的密钥时不会设置任何异常。

返回值:

find_secret(name_or_id, ignore_missing=True)

查找单个密钥

参数:
  • name_or_id – 密钥的名称或 ID。

  • ignore_missing (bool) – 当设置为 False 时,如果资源不存在,将引发 NotFoundException。当设置为 True 时,尝试查找不存在的资源时将返回 None。

返回值:

一个 Secret 或 None

get_secret(secret)

获取单个密钥

参数:

secret – 该值可以是密钥的 ID 或 Secret 实例。

返回值:

一个 Secret

引发:

NotFoundException,当找不到资源时。

secrets(**query)

返回密钥生成器

参数:

query (kwargs) – 可选的查询参数,用于限制返回的资源。

返回值:

密钥对象生成器

返回类型:

Secret

update_secret(secret, **attrs)

更新密钥

参数:
  • secret – 要么是密钥的 id,要么是 Secret 实例。

  • attrs – 要更新到由 secret 表示的密钥上的属性。

返回值:

更新后的密钥

返回类型:

Secret

容器操作

class openstack.key_manager.v1._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
create_container(**attrs)

从属性创建新的容器

参数:

attrs (dict) – 关键字参数,将用于创建 Container,包含 Container 类的属性。

返回值:

容器创建的结果

返回类型:

容器

delete_container(container, ignore_missing=True)

删除容器

参数:
  • container – 该值可以是容器的 ID 或 Container 实例。

  • ignore_missing (bool) – 如果设置为 False,当容器不存在时将引发 NotFoundException。如果设置为 True,则在尝试删除不存在的容器时不会设置任何异常。

返回值:

find_container(name_or_id, ignore_missing=True)

查找单个容器

参数:
  • name_or_id – 容器的名称或 ID。

  • ignore_missing (bool) – 当设置为 False 时,如果资源不存在,将引发 NotFoundException。当设置为 True 时,尝试查找不存在的资源时将返回 None。

返回值:

一个 Container 或 None

get_container(container)

获取单个容器

参数:

container – 该值可以是容器的 ID 或 Container 实例。

返回值:

一个 Container

引发:

NotFoundException,当找不到资源时。

containers(**query)

返回容器生成器

参数:

query (kwargs) – 可选的查询参数,用于限制返回的资源。

返回值:

容器对象生成器

返回类型:

容器

update_container(container, **attrs)

更新容器

参数:
  • container – 要么是容器的 id,要么是 Container 实例。

  • attrs – 要更新到由 container 表示的容器上的属性。

返回值:

更新后的容器

返回类型:

容器

订单操作

class openstack.key_manager.v1._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
create_order(**attrs)

从属性创建新的订单

参数:

attrs (dict) – 关键字参数,将用于创建 Order,包含 Order 类的属性。

返回值:

订单创建的结果

返回类型:

Order

delete_order(order, ignore_missing=True)

删除订单

参数:
  • order – 该值可以是订单的 ID 或 Order 实例。

  • ignore_missing (bool) – 如果设置为 False,当订单不存在时将引发 NotFoundException。如果设置为 True,则在尝试删除不存在的订单时不会设置任何异常。

返回值:

find_order(name_or_id, ignore_missing=True)

查找单个订单

参数:
  • name_or_id – 订单的名称或 ID。

  • ignore_missing (bool) – 当设置为 False 时,如果资源不存在,将引发 NotFoundException。当设置为 True 时,尝试查找不存在的资源时将返回 None。

返回值:

一个 Order 或 None

get_order(order)

获取单个订单

参数:

order – 该值可以是订单的 ID 或 Order 实例。

返回值:

一个 Order

引发:

NotFoundException,当找不到资源时。

orders(**query)

返回订单生成器

参数:

query (kwargs) – 可选的查询参数,用于限制返回的资源。

返回值:

订单对象生成器

返回类型:

Order

update_order(order, **attrs)

更新订单

参数:
  • order – 要么是订单的 ID,要么是一个 Order 实例。

  • attrs – 要更新由 order 表示的订单的属性。

返回值:

更新后的订单

返回类型:

Order