サービス・ブローカが提供するサービスのカタログの取得
get
/openservicebroker/v2/catalog
関連付けられたデータベース・プールのOpen Service Brokerカタログを返します。
リクエスト
ヘッダー・パラメータ
- X-Broker-API-Originating-Identity(optional): string
プラットフォームからリクエストを開始したプラットフォーム・ユーザーのID。このヘッダーの値は2つの部分で構成されます。詳細は、Open Service Brokerの仕様を参照してください。
- X-Broker-API-Request-Identity(optional): string
プラットフォームでは、システム全体を流れる特定のリクエストを一意に識別することが必要な場合があります。このヘッダーには、そのリクエスト追跡情報が保持されます。
- X-Broker-API-Version: string
プラットフォームによって使用されるサービス・ブローカAPIのバージョン番号。
レスポンス
サポートされるメディア・タイプ
- application/json
200 レスポンス
サービス・ブローカで使用可能なすべてのサービスのリスト。
ネストされたスキーマ: services
タイプ:
ソースの表示
array
- 配列: オブジェクト OpenServiceBrokerService
このオブジェクトは、サービス・ブローカで使用可能なすべてのサービスのリストです。
ネストされたスキーマ: OpenServiceBrokerService
タイプ:
object
このオブジェクトは、サービス・ブローカで使用可能なすべてのサービスのリストです。
ソースの表示
- bindable(optional): boolean
サービスのサービス・インスタンスをアプリケーションにバインドできるかどうかを指定します。これにより、このサービス提供のすべてのサービス計画のデフォルトを指定します。
- description(optional): string
サービスの簡単な説明。
- id(optional): string
今後のリクエストにおけるこのサービス提供をサービス・ブローカに関連付けるために使用する識別子。プラットフォーム(およびそのユーザー)が、同じ値を参照することで(どのサービス・ブローカによって使用されていても)常にこのサービス提供が参照されることを想定できるように、これはグローバルに一意である必要があります。
- metadata(optional): object metadata
カタログ・データの表示に役立つ、サービス提供用のメタデータの不透明なオブジェクト。詳細は、[サービス・メタデータの規則](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata)を参照してください。
- name(optional): string
サービス提供の名前。
- plans(optional): array plans
- tags(optional): array tags
サービスの分類、属性または基本テクノロジを公開する柔軟なメカニズムがタグによって提供されるため、アプリケーション、ビルドパックまたはその他のサービスの依存ロジックを変更しないで、同等のサービスをスワップアウトできます。
ネストされたスキーマ: metadata
タイプ:
object
カタログ・データの表示に役立つ、サービス提供用のメタデータの不透明なオブジェクト。詳細は、[サービス・メタデータの規則](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata)を参照してください。
ソースの表示
- displayName(optional): string
グラフィカル・クライアントに表示されるサービスの名前。
- documentationUrl(optional): string
サービスのドキュメント・ページへのリンク。
- imageUrl(optional): string
イメージまたはイメージを含むデータURLへのURL。
- longDescription(optional): string
サービス提供の詳細な説明。
- providerDisplayName(optional): string
実際のサービスを提供するアップストリーム・エンティティの名前。
- supportUrl(optional): string
サービスのサポート・ページへのリンク。
ネストされたスキーマ: plans
タイプ:
ソースの表示
array
- 配列: オブジェクト OpenServiceBrokerPlan
サービス提供の特定のバリアントに対するコストおよび利点の表現(階層として表示される場合もあります)。
ネストされたスキーマ: OpenServiceBrokerPlan
タイプ:
object
サービス提供の特定のバリアントに対するコストおよび利点の表現(階層として表示される場合もあります)。
ソースの表示
- description(optional): string
サービス計画の簡単な説明。
- free(optional): boolean
falseの場合、このサービス計画のサービス・インスタンスにはコストがあります。デフォルトは、trueです。
- id(optional): string
今後のリクエストにおけるこの計画をサービス・ブローカに関連付けるために使用する識別子。プラットフォーム(およびそのユーザー)が、同じ値を参照することで(どのサービス・ブローカによって使用されていても)常にこのサービス計画が参照されることを想定できるように、これはグローバルに一意である必要があります。
- metadata(optional): object metadata
カタログ・データの表示に役立つ、サービス提供用のメタデータの不透明なオブジェクト。詳細は、[サービス・メタデータの規則](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata)を参照してください。
- name(optional): string
サービス計画の名前。
- schemas(optional): object OpenServiceBrokerSchemas
サービス計画のサービス・インスタンスのスキーマ定義。このリリースでは、サービス・バインディングは定義されていないことに注意してください。
ネストされたスキーマ: metadata
タイプ:
object
カタログ・データの表示に役立つ、サービス提供用のメタデータの不透明なオブジェクト。詳細は、[サービス・メタデータの規則](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata)を参照してください。
ソースの表示
- bullets(optional): array bullets
箇条書きリストに表示される、このサービス計画の機能。
- displayName(optional): string
グラフィカル・クライアントに表示されるサービス計画の名前。
ネストされたスキーマ: OpenServiceBrokerSchemas
タイプ:
object
サービス計画のサービス・インスタンスのスキーマ定義。このリリースでは、サービス・バインディングは定義されていないことに注意してください。
ソースの表示
- service_instance(optional): object OpenServiceBrokerServiceInstanceSchema
サービス・インスタンスを作成および更新するためのスキーマ定義。
ネストされたスキーマ: OpenServiceBrokerServiceInstanceSchema
タイプ:
object
サービス・インスタンスを作成および更新するためのスキーマ定義。
ソースの表示
- create(optional): object OpenServiceBrokerSchemaParameters
サービス・ブローカ操作にパラメータを指定するためのスキーマ定義。
ネストされたスキーマ: OpenServiceBrokerSchemaParameters
タイプ:
object
サービス・ブローカ操作にパラメータを指定するためのスキーマ定義。
ソースの表示
- parameters(optional): object parameters
入力パラメータのスキーマ定義。各入力パラメータは、JSONオブジェクト内のプロパティとして表されます。
ネストされたスキーマ: parameters
タイプ:
object
入力パラメータのスキーマ定義。各入力パラメータは、JSONオブジェクト内のプロパティとして表されます。