cloudfoundry-client 1.30.0

支持的版本

• 从版本1.11.0开始，将不再支持比 python 3.6.0更早的版本。此最新版本于 2016 年底发布。对于仍在使用 python 2.7 的用户，到 2020 年底将不再支持它，所有库将停止支持它。

• 从版本1.25.0开始，将不再支持比 python 3.7.0更早的版本。

见官方文档。

从点子

$ pip install cloudfoundry-client

从来源

要构建库运行：

$ python setup.py install

客户

实例化客户端，没有比这更容易的了

from cloudfoundry_client.client import CloudFoundryClient
target_endpoint = 'https://somewhere.org'
proxy = dict(http=os.environ.get('HTTP_PROXY', ''), https=os.environ.get('HTTPS_PROXY', ''))
client = CloudFoundryClient(target_endpoint, proxy=proxy, verify=False)
# init with user credentials
client.init_with_user_credentials('login', 'password')
# init with refresh token (that will retrieve a fresh access token)
client.init_with_token('refresh-token')
# init with access and refresh token (if the above method is not convenient)
client.refresh_token = 'refresh-token'
client._access_token = 'access-token'

如果您拥有带有重定向功能的专用 oauth 应用程序，也可以使用 oauth 代码流对其进行实例化

from flask import request
from cloudfoundry_client.client import CloudFoundryClient
target_endpoint = 'https://somewhere.org'
proxy = dict(http=os.environ.get('HTTP_PROXY', ''), https=os.environ.get('HTTPS_PROXY', ''))
client = CloudFoundryClient(target_endpoint, proxy=proxy, verify=False, client_id='my-client-id', client_secret='my-client-secret')

@app.route('/login')
def login():
    global client
    return redirect(client.generate_authorize_url('http://localhost:9999/code', '666'))

@app.route('/code')
def code():
    global client
    client.init_authorize_code_process('http://localhost:9999/code', request.args.get('code'))

然后您可以按如下方式使用它：

for organization in client.v2.organizations:
    print(organization['metadata']['guid'])

实体

api V2 调用返回的实体（组织、空间、应用程序..）是可导航的，即您可以调用与xxx_url实体属性关联的方法（请注意，如果属性的名称以列表结尾，它将被解释为对象列表. 否则你会得到一个单一的实体）。

for organization in client.v2.organizations:
    for space in organization.spaces(): # perform a GET on spaces_url attribute
        organization_reloaded = space.organization()  # perform a GET on organization_url attribute

Application 对象提供了更多的方法，例如

• 实例

• 统计数据

• 开始

• 停止

• 概括

例如，您可以获得所有摘要，如下所示：

要不然：

for app in client.v2.apps:
    print(app.summary())

可用的经理

到目前为止，可用的已实施管理器有：

• 服务计划

• service_plan_visibilities

• 服务实例

• 服务键

• 服务绑定

• service_brokers

• 应用

• 事件

• 构建包

• 组织

• 空间

• 服务

• 路线

• 共享域

• 私人域名

• 安全组

请注意，即使在导航时到达不存在的实体管理器，也会执行获取，并且您将获得预期的实体。例如，事件实体管理器尚未实现，但您可以执行

for app in client.v2.apps:
    for event in app.events():
        handle_event_object()

所有管理器都提供以下方法：

• list(**kwargs)：根据给定的过滤参数返回实体上的迭代器

• get_first(**kwargs)：根据给定的参数返回第一个匹配的实体。如果没有返回，则返回`None

• get ：对实体执行GET 。如果无法找到实体，则会由于 http NOT FOUND响应状态而引发异常

• __iter__：对管理器本身的迭代。无过滤器列表的别名

• __getitem__ : get操作的别名

• _create：创建操作。由于是泛型操作（只接受一个dict对象），所以这个操作是受保护的

• _update：更新操作。由于它是一个通用操作（只需要一个资源 id 和一个dict对象），这个操作是受保护的

• _remove：删除操作。此操作保持受保护。

# Assume you have an organization named `test-org` with a guid of `test-org-guid`
org_get = client.v2.organizations.get('test-org-guid')
org_get_first = client.v2.organizations.get_first(**{'name': 'test-org'})
org_from_list = list(client.v2.organizations.list(**{'name': 'test-org'}))[0]
assert org_get == org_get_first == org_from_list

# You can also specify multiple values for a query parameter.
for organization in client.v2.organizations.list(**{'name': ['org1', 'org2']}):
    print(organization['metadata']['guid'])

# Order and Paging parameters are also supported.
query = {
    'order-by': 'name',
    'order-direction': 'desc',
    'results-per-page': 100
}
for organization in client.v2.organizations.list(**query):
    print(organization['entity']['name'])