所有服务代理程序的必需端点逻辑

服务代理程序必须提供 REST API 使用的一组标准元数据值，并且 IBM Cloud 代理程序必须包含用于以下 REST API 端点或路径的逻辑：

目录 (GET)

返回代理程序中包含的目录元数据。

资源实例 (PUT)

创建服务实例。

资源实例 (DELETE)

删除服务实例。

资源实例 (PATCH)

更新服务实例。

关于目录 (GET) 的注释：此端点定义代理程序与 IBM Cloud 平台（用于代理程序支持的服务和套餐）之间的合同。 该端点返回存储在代理中的目录元数据。 这些值定义了您的服务与 IBM Cloud 平台之间的最低合同。 所有不需要的附加目录元数据都存储在 IBM Cloud 目录中。 必须在 IBM Cloud 控制台中更新对目录显示值 (例如链接和图标) 的任何更新，并且这些更新不能包含在代理程序中。 代理程序中存储的任何元数据都不会显示在 IBM Cloud 控制台或 IBM Cloud CLI 中。 控制台和 CLI 会返回在 Partner Center Sell 中设置并存储在 IBM Cloud 目录中的内容。 下一节显示了目录 (GET) 返回的最小必要值：

{
       "services": [{
           "id": "0bc9d744-6f8c-4821-9648-2278bf6925bb",
           "name": "ibmcloud-link",
           "description": "An IBM provided service that enables aliasing to service instances in the IBM Cloud.",
           "bindable": true,
           "plan_updateable": false,
           "plans": [
               {
                   "id": "da40662d-2f72-4a19-8c79-8c77cf285e1",
                   "name": "ibmcloud-alias",
                   "free": true,
                   "description": "The IBM Cloud alias plan used for linking."
               }
               ]
       }]
}

可绑定服务的必需端点逻辑

如果您的服务可以绑定到 IBM Cloud 中的应用程序，它必须向您的服务消费者返回 API 端点和凭据。 可绑定服务必须使用 Open Service Broker 规范中的可绑定操作，并实现以下端点或路径：

绑定和凭证 (PUT)

将服务实例绑定到应用程序。

绑定和凭证 (DEL)

取消服务实例与应用程序的绑定。

必需的 IBM Cloud 扩展端点

OSB 规范不支持已禁用的实例状态。 禁用状态包括缺少付款或导致帐户暂挂 (但尚未取消) 且不同于已删除实例状态的其他情境。 为了使 IBM Cloud 支持可能迂到禁用状态的客户，IBM Cloud 定义了允许禁用和重新启用服务实例的扩展 API 端点。 需要以下终端扩展：

启用和禁用实例 (GET)

状态 - 返回服务实例的状态。

启用和禁用实例 (PUT)

启用或禁用服务实例。

在禁用端点启动时禁用对服务实例的访问，以及在启用端点启动时重新启用对服务实例的访问，是服务提供者的责任。

X-Broker-API-Originating-Identity

用户身份标头通过 API 起源身份标头提供。 此请求头包含用户的 IBM Cloud IAM 身份。 IAM 身份是 base64 编码的。IBM Cloud 支持单个认证域: IBMid。 IBMid 域使用 IBMid 唯一标识 (IUI) 来标识 IBM Cloud 中的用户身份。 此 IUI 是服务提供者的不透明字符串。

示例：

X-Broker-API-Originating-Identity: ibmcloud eyJpYW1faWQiOiJJQk1pZC01MEdOUjcxN1lFIn0=
Decoded:
{"iam_id":"IBMid-50GNR717YE"}

API 版本头

API 版本头 是 2.12。 例如：X-Broker-Api-Version: 2.12。

资源实例 (PUT) body.context 和资源实例 (PATCH) body.context

PUT /v2/service_instances/:resource_instance_id 和 PATCH /v2/service_instances/:resource_instance_id 会在 body.context 中接收以下值：{ "platform": "ibmcloud", "account_id": "tracys-account-id", "crn": "resource-instance-crn" }。

有关使用异步操作取代同步操作的建议

OSB API 支持同步和异步操作方式。 如果您的操作需要少于 10 秒，那么必须使用同步响应。 否则，必须使用异步操作方式。 异步方式需要 last_operation 端点。 有关更多信息，请参阅 获取服务实例的正在进行的供应的状态。

管理不同位置代理程序的建议

用户必须了解其云服务的位置，才能确定等待时间、可用性和数据存储位置。

在 IBM Cloud 上创建服务实例时，用户需要提供的参数之一是他们希望创建服务实例的位置。 有些服务可支持在多个地点创建。 例如，数据库服务可以支持在所有 IBM Cloud 区域中创建，也可以支持子集。

如果基于第三方 API 的服务在另一个云中实施，并在 IBM Cloud 中公开，那么该位置会指示该服务在其他云中的位置。

上线到 IBM Cloud 时，必须至少实施一个 OSB 代理程序。 但您可根据部署策略和要为服务提供支持的位置，实施多个代理程序。 在 Partner Center Sell 中，您可以建立定价套餐与代理之间的映射。 典型的选择是定义一个代理为所有地点提供服务，或者为每个地点定义一个代理；这取决于服务提供商的选择。

要获取可用位置的列表，请查看 IBM 全局目录位置。 如果您的服务需要定义更多位置，请咨询 IBM Cloud 入职团队。