产品组件
更新时间: 2023-04-19
# 产品绑定组件
# 基本信息
Path: /v1/products/:instanceId/:productKey/components
Method: POST
接口描述: 最大支持绑定20个组件
# 请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
instanceId | ||
productKey |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
components | object [] | 非必须 | |||
├─ bindName | string | 非必须 | 槽位 | ||
├─ component | string | 非必须 | 组件的productKey |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
total | integer | 非必须 | |||
reslut | object [] | 非必须 | |||
├─ instanceId | string | 必须 | 实例ID | ||
├─ productKey | string | 必须 | 产品ID | ||
├─ bindName | string | 必须 | 槽位 | ||
├─ component | string | 必须 | 组件的productKey | ||
├─ componentName | string | 必须 | 组件的productName | ||
├─ description | string | 必须 | 组件的description | ||
├─ createTime | string | 必须 | |||
├─ updateTime | string | 必须 |
# 获取已绑定组件列表
# 基本信息
Path: /v1/products/:instanceId/:productKey/components
Method: GET
接口描述:
最大支持绑定20个组件,暂不支持分页、模糊匹配等参数
# 请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
instanceId | ||
productKey |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
result | object [] | 非必须 | |||
├─ instanceId | string | 必须 | |||
├─ productKey | string | 必须 | |||
├─ bindName | string | 必须 | |||
├─ component | string | 必须 | |||
├─ componentName | string | 必须 | |||
├─ updateTime | string | 必须 | |||
├─ createTime | string | 必须 | |||
├─ description | string | 必须 | |||
total | number | 非必须 |
# 解除组件绑定
# 基本信息
Path: /v1/products/:instanceId/:productKey/components/:bindName
Method: DELETE
接口描述:
# 请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
instanceId | ||
productKey | ||
bindName |
# 返回数据
无