Call this operation to delete a specified tag of a device.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to DeleteDeviceProp.
IotId String No

The unique identifier of the device whose tag you want to delete.

Note If you use this parameter, ProductKey and DeviceName are not required. IotId is a globally unique identifier (GUID) of a device, and corresponds to the combination of ProductKey and DeviceName. If you specify both IotId and the combination of ProductKey and DeviceName, the system follows IotId.
ProductKey String No

The product key of the device whose tag you want to delete.

Note If you use this parameter, DeviceName is required.
DeviceName String No

The name of the device whose tag you want to delete.

Note If you use this parameter, ProductKey is required.
PropKey String Yes

The key of the tag that you want to delete.

Note IoT Platform will search for the specified key in the tags of the device, and will delete the tag with the key. If the specified key is not found in the tags of the device, no action will be performed.
Common Request Parameters - Yes See Common parameters.

Response parameters

Parameter Type Description
RequestId String The globally unique ID generated by Alibaba Cloud for the request.
Success Boolean Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call has failed.
ErrorMessage String The error message returned when the call fails.
Code String The error code returned when the call fails. For more information on error codes, see Error codes.

Examples

Request example

https://iot.cn-shanghai.aliyuncs.com/?Action=DeleteDeviceProp
&ProductKey=al*********
&DeviceName=device1
&PropKey=temperature
&Public Request Parameters

Response example

  • JSON format

    {
    "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
    "Success": true
}

  • XML format

    <? xml version='1.0' encoding='utf-8'? >
<DeleteDevicePropResponse>
    <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
    <Success>true</Success>
</DeleteDevicePropResponse>