Updated on 2024-06-27 GMT+08:00

Unbind Tags

Function

This API is used by an application to unbind tags from a specific resource. Currently, only devices can be tagged.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description: project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Parameter description: user token. You can obtain the token by calling the IAM API Obtaining a User Token Through Password Authentication. X-Subject-Token in the response header returned by the API is the desired user token. For details about how to obtain the token, see Token Authentication.

Instance-Id

No

String

Parameter description: instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

resource_type

Yes

String

Parameter description: type of the resource that tags are to be bound to. Options:

  • device: device.

resource_id

Yes

String

Parameter description: ID of the resource that tags are to be bound to. For example, if resource_type is set to device, set this parameter to the device ID. Value: The value can contain a maximum of 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

tag_keys

Yes

Array of strings

Parameter description: keys of tags to be unbound from the resource. Each tag key must be unique in the tag list. Value: The value can contain a maximum of 64 characters. Only letters, digits, underscores (_), periods (.), and hyphens (-) are allowed.

Response Parameters

None

Example Requests

Unbinds the testkey tag from the device whose ID is d4922d8a.

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

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

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.