服务目录（必需)
服务目录查询接口的作用是：提供服务内容的描述，包括服务产品、服务计划、服务实例创建、服务实例更新等信息的描述，涵盖商品的发布、开通使用等生命周期节点
接口类型
接口类型为：GET，请求地址可自行定义。
请求消息体
无。
响应消息体
字段名称 |
类型 |
必填 |
说明 |
services |
Array<ServiceOffering> |
是 |
接入方提供的服务产品列表。 |
服务产品ServiceOffering
字段名称 |
类型 |
必填 |
说明 |
name |
string |
是 |
服务产品名称。 |
id |
string |
是 |
服务产品标识，用于唯一性识别。 |
description |
string |
是 |
服务产品说明。 |
plans |
Array<ServicePlan> |
是 |
服务计划列表。 |
tags |
Array<string> |
否 |
标签列表。 |
requires |
Array<string> |
否 |
正常使用该服务，必须给用户授予的权限列表。 |
bindable |
boolean |
是 |
标识当前服务实例是否可以被绑定到应用，当前服务下的所有服务计划继承该值，也允许服务计划覆盖。 |
metadata |
JSONObject |
否 |
描述服务产品如何渲染的元数据，依赖于Broker和Exchange的约定，在Exchange上直接作为二进制对象使用。 |
dashboard_client |
DashboardClient |
否 |
Cloud Foundry（开源云应用程序平台）扩展，包括激活当前服务仪表板SSO功能所需的数据。 |
plan_updateable |
boolean |
否 |
服务计划是否默认支持升级。 |
instances_retrievable |
boolean |
否 |
从服务计划中是否可获取服务实例接入点信息。 |
bindings_retrievable |
boolean |
否 |
从服务计划中是否可获取服务绑定接入点信息。 |
allow_context_updates |
boolean |
否 |
指定当平台中服务实例的上下文数据发生变化时，服务实例是否支持更新请求。 |
看板客户端信息DashboardClient
字段名称 |
类型 |
必填 |
说明 |
id |
string |
是 |
仪表板客户端ID。 |
secret |
string |
是 |
仪表板秘钥。 |
redirect_uri |
string |
否 |
仪表板的URI，提供给OAuth令牌服务器验证。 |
服务计划ServicePlan
字段名称 |
类型 |
必填 |
说明 |
name |
string |
是 |
服务计划名称。 |
id |
string |
是 |
服务计划标识。商品发布时，默认要选取到服务计划层级，需要记录商品与服务计划的映射关系。 |
description |
string |
是 |
服务计划说明。 |
bindable |
boolean |
否 |
服务实例中的服务计划是否允许被绑定，若不允许则不调用服务绑定接口。 |
metadata |
JSONObject |
否 |
描述服务计划如何渲染的元数据，依赖于Broker和Exchange的约定，在Exchange上直接作为二进制对象使用。 |
maintenance_info |
MaintenanceInfo |
否 |
使用服务计划开通的服务实例的维护信息。 |
free |
boolean |
否 |
此服务计划的服务实例是否免费，默认免费。 |
plan_updateable |
boolean |
否 |
当前服务计划是否支持升级到其他版本。 |
maximum_polling_duration |
number |
否 |
轮询的最大持续时间，若达到或超过该值，则平台应停止轮询，操作状态被视为失败。 |
schemas |
PlanSchema |
否 |
当前计划对应的服务实例和服务绑定的结构定义。 |
维护信息MaintenanceInfo
字段名称 |
类型 |
必填 |
说明 |
version |
string |
是 |
版本号。 |
description |
string |
否 |
版本描述。 |
服务内容PlanSchema
字段名称 |
类型 |
必填 |
说明 |
service_instance |
ServiceInstanceSchema |
否 |
创建和更新服务实例的结构定义。 |
service_binding |
ServiceBindingSchema |
否 |
服务绑定的结构定义。 |
服务实例结构定义ServiceInstanceSchema
字段名称 |
类型 |
必填 |
说明 |
create |
InputParameterSchema |
否 |
创建服务实例的结构定义。若该参数不为空，则在创建服务实例前Exchange需要提供一个界面与用户进行交互，用于构建服务实例创建接口的parameters信息。 |
update |
InputParameterSchema |
否 |
更新服务实例的结构定义。若该参数不为空，则在更新服务实例前Exchange需要提供一个界面与用户进行交互，用于构建服务实例更新接口的parameters信息。 |
服务绑定结构定义ServiceBindingSchema
字段名称 |
类型 |
必填 |
说明 |
create |
InputParameterSchema |
否 |
服务绑定的结构定义。若该参数不为空，则在绑定服务实例前Exchange需要提供一个界面与用户进行交互，用于构建服务绑定接口的parameters信息。 |
描述参数InputParameterSchema
字段名称 |
类型 |
必填 |
说明 |
parameters |
JSONObject |
否 |
JSON Schema，形如：
{
"type": "object",
"properties": {
"x": {
"description": "X坐标",
"minimum": 0,
"maximum": 10,
"default": 0,
"type": "number"
},
"y": {
"description": "Y坐标",
"minimum": 0,
"maximum": 20,
"default": 0,
"type": "number"
},
"desc": {
"description": "坐标描述",
"pattern": "^[a-zA-Z0-9]+$",
"maxLength": 24,
"type": "string"
}
},
"required": [
"x",
"y"
],
"$schema": "http://json-schema.org/draft-07/schema#"
} |
