Cloud Services API ReferenceIoT CoreDevice ManagementModify Basic Properties

Modify Basic Properties

Last Updated on : 2023-11-23 06:41:25download

Based on the device ID, modify the basic properties of the specified device. You can modify information such as the device name and icon, as well as latitude and longitude.

API address

POST: /v2.0/cloud/thing/{device_id}/attribute

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	path	true	The device ID.

Description of body

Parameter name	Type	IN	Required	Description
type	Integer	body	true	The type of the basic properties. Valid values: `1`: Modify the device name. `2`: Modify the device icon. `3`: Modify the latitude and longitude of the device location. The latitude and longitude format is `latitude:longitude`, separated by a colon. For example, `120.15:30.48`.
data	String	body	true	The data.

Return parameter

Parameter name	Type	Description
result	Boolean	Indicates whether the operation is successful. Valid values: `true`: The operation succeeded. `false`: The operation failed.
success	Boolean	Indicates whether the API is called successfully. Valid values: `true`: The API call succeeded. `false`: The API call failed.
t	Long	The timestamp.
tid	String	The link ID.

Request example

POST: /v2.0/cloud/thing/6c19224514c02f7490****/attribute

{
  "type": 1,
  "data": "Main Bedroom Light"
}

Return example

{
    "tid": "b8a2b49abbbc11eda71e169efc83a172",
    "result": true,
    "t": 1678065474602,
    "success": true
}

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.

Prev DocGet Operation Log

Next DocFreeze/Unfreeze Device