ジャンプ先

• リクエスト
• レスポンス

サービス・ブローカが提供するサービスのカタログの取得

get

/openservicebroker/v2/catalog

関連付けられたデータベース・プールのOpen Service Brokerカタログを返します。

リクエスト

ヘッダー・パラメータ

• X-Broker-API-Originating-Identity:
  プラットフォームからリクエストを開始したプラットフォーム・ユーザーのID。このヘッダーの値は2つの部分で構成されます。詳細は、Open Service Brokerの仕様を参照してください。
• X-Broker-API-Request-Identity:
  プラットフォームでは、システム全体を流れる特定のリクエストを一意に識別することが必要な場合があります。このヘッダーには、そのリクエスト追跡情報が保持されます。
• X-Broker-API-Version(required):
  プラットフォームによって使用されるサービス・ブローカAPIのバージョン番号。

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200 レスポンス

サービス・ブローカで使用可能なすべてのサービスのリスト。

本文 ()

ルート・スキーマ: OpenServiceBrokerCatalog

タイプ: object

このオブジェクトは、サービス・ブローカで使用可能なすべてのサービスのリストです。

ソースの表示

• services: array services

{
    "type":"object",
    "description":"This object is a list of all services available on the Service Broker.",
    "properties":{
        "services":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OpenServiceBrokerService"
            }
        }
    }
}

ネストされたスキーマ: services

タイプ: array

ソースの表示

• 配列: オブジェクト OpenServiceBrokerService
  このオブジェクトは、サービス・ブローカで使用可能なすべてのサービスのリストです。

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OpenServiceBrokerService"
    }
}

ネストされたスキーマ: OpenServiceBrokerService

タイプ: object

このオブジェクトは、サービス・ブローカで使用可能なすべてのサービスのリストです。

ソースの表示

• bindable: boolean
  サービスのサービス・インスタンスをアプリケーションにバインドできるかどうかを指定します。これにより、このサービス提供のすべてのサービス計画のデフォルトを指定します。
• description: string
  サービスの簡単な説明。
• id: string
  今後のリクエストにおけるこのサービス提供をサービス・ブローカに関連付けるために使用する識別子。プラットフォーム(およびそのユーザー)が、同じ値を参照することで(どのサービス・ブローカによって使用されていても)常にこのサービス提供が参照されることを想定できるように、これはグローバルに一意である必要があります。
• metadata: object metadata
  カタログ・データの表示に役立つ、サービス提供用のメタデータの不透明なオブジェクト。詳細は、[サービス・メタデータの規則](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata)を参照してください。
• name: string
  サービス提供の名前。
• plans: array plans
• tags: array tags
  サービスの分類、属性または基本テクノロジを公開する柔軟なメカニズムがタグによって提供されるため、アプリケーション、ビルドパックまたはその他のサービスの依存ロジックを変更しないで、同等のサービスをスワップアウトできます。

{
    "type":"object",
    "description":"This object is a list of all services available on the Service Broker.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the Service Offering."
        },
        "id":{
            "type":"string",
            "description":"An identifier used to correlate this Service Offering in future requests to the Service Broker. This MUST be globally unique such that Platforms (and their users) MUST be able to assume that seeing the same value (no matter what Service Broker uses it) will always refer to this Service Offering."
        },
        "description":{
            "type":"string",
            "description":"A short description of the service."
        },
        "bindable":{
            "type":"boolean",
            "description":"Specifies whether Service Instances of the service can be bound to applications. This specifies the default for all Service Plans of this Service Offering."
        },
        "tags":{
            "type":"array",
            "description":"Tags provide a flexible mechanism to expose a classification, attribute, or base technology of a service, enabling equivalent services to be swapped out without changes to dependent logic in applications, buildpacks, or other services.",
            "items":{
                "type":"string"
            }
        },
        "metadata":{
            "type":"object",
            "description":"An opaque object of metadata for a Service Offering which aid in the display of catalog data. See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata) for more details.",
            "properties":{
                "displayName":{
                    "type":"string",
                    "description":"The name of the service to be displayed in graphical clients."
                },
                "documentationUrl":{
                    "type":"string",
                    "description":"Link to documentation page for the service."
                },
                "imageUrl":{
                    "type":"string",
                    "description":"TThe URL to an image or a data URL containing an image."
                },
                "longDescription":{
                    "type":"string",
                    "description":"Long description of the Service Offering."
                },
                "providerDisplayName":{
                    "type":"string",
                    "description":"The name of the upstream entity providing the actual service."
                },
                "supportUrl":{
                    "type":"string",
                    "description":"Link to support page for the service."
                }
            }
        },
        "plans":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OpenServiceBrokerPlan"
            }
        }
    }
}

ネストされたスキーマ: metadata

タイプ: object

カタログ・データの表示に役立つ、サービス提供用のメタデータの不透明なオブジェクト。詳細は、[サービス・メタデータの規則](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata)を参照してください。

ソースの表示

• displayName: string
  グラフィカル・クライアントに表示されるサービスの名前。
• documentationUrl: string
  サービスのドキュメント・ページへのリンク。
• imageUrl: string
  イメージまたはイメージを含むデータURLへのURL。
• longDescription: string
  サービス提供の詳細な説明。
• providerDisplayName: string
  実際のサービスを提供するアップストリーム・エンティティの名前。
• supportUrl: string
  サービスのサポート・ページへのリンク。

{
    "type":"object",
    "description":"An opaque object of metadata for a Service Offering which aid in the display of catalog data. See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata) for more details.",
    "properties":{
        "displayName":{
            "type":"string",
            "description":"The name of the service to be displayed in graphical clients."
        },
        "documentationUrl":{
            "type":"string",
            "description":"Link to documentation page for the service."
        },
        "imageUrl":{
            "type":"string",
            "description":"TThe URL to an image or a data URL containing an image."
        },
        "longDescription":{
            "type":"string",
            "description":"Long description of the Service Offering."
        },
        "providerDisplayName":{
            "type":"string",
            "description":"The name of the upstream entity providing the actual service."
        },
        "supportUrl":{
            "type":"string",
            "description":"Link to support page for the service."
        }
    }
}

ネストされたスキーマ: plans

タイプ: array

ソースの表示

• 配列: オブジェクト OpenServiceBrokerPlan
  サービス提供の特定のバリアントに対するコストおよび利点の表現(階層として表示される場合もあります)。

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OpenServiceBrokerPlan"
    }
}

ネストされたスキーマ: tags

タイプ: array

サービスの分類、属性または基本テクノロジを公開する柔軟なメカニズムがタグによって提供されるため、アプリケーション、ビルドパックまたはその他のサービスの依存ロジックを変更しないで、同等のサービスをスワップアウトできます。

ソースの表示

• 配列: 文字列

{
    "type":"array",
    "description":"Tags provide a flexible mechanism to expose a classification, attribute, or base technology of a service, enabling equivalent services to be swapped out without changes to dependent logic in applications, buildpacks, or other services.",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: OpenServiceBrokerPlan

タイプ: object

サービス提供の特定のバリアントに対するコストおよび利点の表現(階層として表示される場合もあります)。

ソースの表示

• description: string
  サービス計画の簡単な説明。
• free: boolean
  falseの場合、このサービス計画のサービス・インスタンスにはコストがあります。デフォルトは、trueです。
• id: string
  今後のリクエストにおけるこの計画をサービス・ブローカに関連付けるために使用する識別子。プラットフォーム(およびそのユーザー)が、同じ値を参照することで(どのサービス・ブローカによって使用されていても)常にこのサービス計画が参照されることを想定できるように、これはグローバルに一意である必要があります。
• metadata: object metadata
  カタログ・データの表示に役立つ、サービス提供用のメタデータの不透明なオブジェクト。詳細は、[サービス・メタデータの規則](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata)を参照してください。
• name: string
  サービス計画の名前。
• schemas: object OpenServiceBrokerSchemas
  サービス計画のサービス・インスタンスのスキーマ定義。このリリースでは、サービス・バインディングは定義されていないことに注意してください。

{
    "type":"object",
    "description":"The representation of the costs and benefits for a given variant of the Service Offering, potentially as a tier.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the Service Plan."
        },
        "id":{
            "type":"string",
            "description":"An identifier used to correlate this Plan in future requests to the Service Broker. This MUST be globally unique such that Platforms (and their users) MUST be able to assume that seeing the same value (no matter what Service Broker uses it) will always refer to this Service Plan."
        },
        "description":{
            "type":"string",
            "description":"A short description of the Service Plan."
        },
        "free":{
            "type":"boolean",
            "description":"When false, Service Instances of this Service Plan have a cost. The default is true."
        },
        "metadata":{
            "type":"object",
            "description":"An opaque object of metadata for a Service Offering which aid in the display of catalog data. See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata) for more details.",
            "properties":{
                "displayName":{
                    "type":"string",
                    "description":"The name of the Service Plan to be displayed in graphical clients."
                },
                "bullets":{
                    "type":"array",
                    "description":"Features of this Service Plan, to be displayed in a bulleted-list.",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "schemas":{
            "$ref":"#/components/schemas/OpenServiceBrokerSchemas"
        }
    }
}

ネストされたスキーマ: metadata

タイプ: object

カタログ・データの表示に役立つ、サービス提供用のメタデータの不透明なオブジェクト。詳細は、[サービス・メタデータの規則](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata)を参照してください。

ソースの表示

• bullets: array bullets
  箇条書きリストに表示される、このサービス計画の機能。
• displayName: string
  グラフィカル・クライアントに表示されるサービス計画の名前。

{
    "type":"object",
    "description":"An opaque object of metadata for a Service Offering which aid in the display of catalog data. See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata) for more details.",
    "properties":{
        "displayName":{
            "type":"string",
            "description":"The name of the Service Plan to be displayed in graphical clients."
        },
        "bullets":{
            "type":"array",
            "description":"Features of this Service Plan, to be displayed in a bulleted-list.",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: OpenServiceBrokerSchemas

タイプ: object

サービス計画のサービス・インスタンスのスキーマ定義。このリリースでは、サービス・バインディングは定義されていないことに注意してください。

ソースの表示

• service_instance: object OpenServiceBrokerServiceInstanceSchema
  サービス・インスタンスを作成および更新するためのスキーマ定義。

{
    "type":"object",
    "description":"Schema definitions for Service Instances for the Service Plan. Note that Service Bindings not defined in this release.",
    "properties":{
        "service_instance":{
            "$ref":"#/components/schemas/OpenServiceBrokerServiceInstanceSchema"
        }
    }
}

ネストされたスキーマ: bullets

タイプ: array

箇条書きリストに表示される、このサービス計画の機能。

ソースの表示

• 配列: 文字列

{
    "type":"array",
    "description":"Features of this Service Plan, to be displayed in a bulleted-list.",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: OpenServiceBrokerServiceInstanceSchema

タイプ: object

サービス・インスタンスを作成および更新するためのスキーマ定義。

ソースの表示

• create: object OpenServiceBrokerSchemaParameters
  サービス・ブローカ操作にパラメータを指定するためのスキーマ定義。

{
    "type":"object",
    "description":"The schema definitions for creating and updating a Service Instance.",
    "properties":{
        "create":{
            "$ref":"#/components/schemas/OpenServiceBrokerSchemaParameters"
        }
    }
}

ネストされたスキーマ: OpenServiceBrokerSchemaParameters

タイプ: object

サービス・ブローカ操作にパラメータを指定するためのスキーマ定義。

ソースの表示

• parameters: object parameters
  入力パラメータのスキーマ定義。各入力パラメータは、JSONオブジェクト内のプロパティとして表されます。

{
    "type":"object",
    "description":"The schema definitions for providing parameters to a Service Broker operation.",
    "properties":{
        "parameters":{
            "description":"The schema definition for the input parameters. Each input parameter is expressed as a property within a JSON object.",
            "type":"object"
        }
    }
}

ネストされたスキーマ: parameters

タイプ: object

入力パラメータのスキーマ定義。各入力パラメータは、JSONオブジェクト内のプロパティとして表されます。

先頭に戻る