设备标签
更新时间: 2023-04-19
# 删除标签
# 基本信息
Path: /v1/devices/:instanceId/:productKey/:deviceName/tags/:key
Method: DELETE
接口描述:
# 请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
instanceId | ||
productKey | ||
deviceName | ||
key |
# 返回数据
无
# 新建标签
# 基本信息
Path: /v1/devices/:instanceId/:productKey/:deviceName/tags
Method: POST
接口描述:
# 请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
instanceId | ||
productKey | ||
deviceName |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
tags | object [] | 必须 | |||
├─ key | string | 必须 | 1~32字符, 字母开头, 可为大小写英文、数字、中线、下划线。 | ||
├─ value | string | 必须 | 1~32字符。 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
tags | object [] | 非必须 | item 类型: object | ||
├─ key | string | 必须 | |||
├─ value | string | 必须 |
# 查询指定标签key的value
# 基本信息
Path: /v1/devices/:instanceId/tags/value
Method: GET
接口描述:
# 请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
instanceId |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
key | 是 | 指定标签key |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
string [] | 非必须 | 指定标签key的value | |||
├─ | 非必须 |
# 查询标签列表
# 基本信息
Path: /v1/devices/:instanceId/:productKey/:deviceName/tags
Method: GET
接口描述: inherited = true时不允许删除
# 请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
instanceId | ||
productKey | ||
deviceName |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
tags | object [] | 非必须 | |||
├─ key | string | 非必须 | |||
├─ value | string | 非必须 | |||
├─ inherited | boolean | 非必须 |
# 查询设备标签所有key
# 基本信息
Path: /v1/devices/:instanceId/tags/key
Method: GET
接口描述:
# 请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
instanceId |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
keyPrefix | 否 | 设备标签key前缀 |
# 返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
string [] | 非必须 | 标签key列表 | |||
├─ | 非必须 |