更新时间:2024-05-29 GMT+08:00

解绑标签

功能介绍

应用服务器可调用此接口为指定资源解绑标签。当前支持标签的资源有Device(设备)。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v5/iot/{project_id}/tags/unbind-resource

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数说明:项目ID。获取方法请参见 获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

Instance-Id

String

参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考 查看实例详情

表3 请求Body参数

参数

是否必选

参数类型

描述

resource_type

String

参数说明:要绑定标签的资源类型。 取值范围

  • device:设备。

resource_id

String

参数说明:要绑定标签的资源id。例如,资源类型为device,那么对应的资源id就是device_id。 取值范围:长度不超过128,只允许字母、数字、下划线(_)、连接符(-)的组合。

tag_keys

Array of strings

参数说明:指定资源要解绑的标签键列表,标签键列表中各项之间不允许重复,不能填写不存在的标签键值 取值范围:标签键长度不超过64,只允许中文、字母、数字、以及_.-等字符的组合。

响应参数

请求示例

资源解绑标签,将标签testkey从设备id为d4922d8a的设备解绑。

POST https://{endpoint}/v5/iot/{project_id}/tags/unbind-resource

{
  "resource_type" : "device",
  "resource_id" : "d4922d8a",
  "tag_keys" : [ "testTag" ]
}

响应示例

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码