子产品
更新时间: 2023-04-19
# 同实例下该产品还没有绑定子产品列表
# 基本信息
Path: /v1/products/:instanceId/subsets
Method: GET
接口描述:
# 请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
instanceId |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
pageNo | 是 | ||
pageSize | 是 | ||
productKey | 是 | 网关产品 | |
subProductName | 否 | 产品名称搜索 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
totalCount | number | 非必须 | |||
result | object [] | 非必须 | |||
├─ productName | string | 必须 | |||
├─ createTime | string | 必须 | |||
├─ description | string | 必须 | |||
├─ deviceType | string | 必须 | |||
├─ instanceId | string | 必须 | |||
├─ productKey | string | 必须 | |||
├─ accessType | string [] | 必须 | |||
├─ | 非必须 | ||||
├─ productSecret | string | 必须 | |||
├─ updateTime | string | 必须 | |||
pageSize | number | 非必须 | |||
pageNo | number | 非必须 |
# 已绑定子产品列表
# 基本信息
Path: /v1/products/:instanceId/subsets/:productKey
Method: GET
接口描述:
# 请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
instanceId | ||
productKey |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
pageNo | 是 | 不分页的话 默认1 | |
pageSize | 是 | 不分页的话 默认200 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
totalCount | number | 非必须 | |||
result | object [] | 非必须 | |||
├─ productName | string | 必须 | |||
├─ createTime | string | 必须 | |||
├─ description | string | 必须 | |||
├─ deviceType | string | 必须 | |||
├─ instanceId | string | 必须 | |||
├─ productKey | string | 必须 | |||
├─ accessType | string [] | 必须 | |||
├─ | 非必须 | ||||
├─ productSecret | string | 必须 | |||
├─ updateTime | string | 必须 | |||
pageSize | number | 非必须 | |||
pageNo | number | 非必须 |
# 批量子产品解绑
# 基本信息
Path: /v1/products/:instanceId/subsets/:productKey/delete
Method: POST
接口描述:
# 请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
instanceId | ||
productKey |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
string [] | 非必须 | ||||
├─ | 非必须 | 子产品的productKey |
# 返回数据
无
# 批量绑定子产品
# 基本信息
Path: /v1/products/:instanceId/subsets/:productKey
Method: POST
接口描述:
# 请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
instanceId | ||
productKey |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
string [] | 非必须 | ||||
├─ | 非必须 | 子产品的productKey |
# 返回数据
无