Modifying Device Information
Typical Scenario
After an application registers a device with the platform and the basic information about the device changes, the application can also call this API to modify device information on the platform.
API Function
This API is used to modify the basic information about a device, including the device type, device model, manufacturer, and access protocol.
API Description
1 | void modifyDeviceInfo(ModifyDeviceInforInDTO mdiInDto, String deviceId, String appId, String accessToken) throws NorthApiException
|
Class
DeviceManagement
Parameter Description
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| deviceId | Mandatory | String | path | Identifies a device. The device ID is allocated by the platform during device registration. |
| appId | Mandatory | String | query | If the device belongs to the current application, set this parameter to null. Otherwise, set this parameter to the ID of the authorized application. |
| accessToken | Mandatory | String | header | If the Periodically Refreshing a Token API is called, set this parameter to null. Otherwise, set this parameter to the accessToken obtained by the Authentication API. |
| mdiInDto | Mandatory | ModifyDeviceInforInDTO | body | For details, see ModifyDeviceInforInDTO structure. |
ModifyDeviceInforInDTO structure
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| customFields | Optional | List<CustomField> | Body | Customized field list. |
| imsi | Optional | String(1-64) | Body | Indicates the IMSI of an NB-IoT device. |
| name | Optional | String(1-256) | body | Indicates the device name. |
| endUser | Optional | String(1-256) | body | Indicates an end user. If the device is a directly connected device, this parameter is optional. If the device is an indirectly connected device, this parameter can be set to null. |
| mute | Optional | Enum | body | Indicates whether the device is in the frozen state. Based on the value of this parameter, the platform determines whether to manage and store data reported by the device.
|
| manufacturerId | Optional | String(1-256) | body | Uniquely identifies a manufacturer. After registering a device, you must change the manufacturer ID to be the same as that defined in the product model. |
| manufacturerName | Optional | String(1-256) | body | Indicates the manufacturer name. |
| deviceType | Optional | String(1-256) | body | Indicates the device type. The upper camel case is used, for example, MultiSensor, ContactSensor, and CameraGateway. In the NB-IoT solution, the device type must be changed to be the same as that defined in the product model after a device is registered. |
| model | Optional | String(1-256) | body | Indicates the device model, which is defined by the manufacturer. After registering a device, you must change the device model to be the same as that defined in the product model. |
| location | Optional | String(1-1024) | body | Indicates the device location. |
| protocolType | Optional | String(1-256) | body | Indicates the protocol used by the device. The value options are CoAP, huaweiM2M, Z-Wave, ONVIF, WPS, Hue, WiFi, J808, Gateway, ZigBee, and LWM2M. After registering a device, you must change the protocol to be the same as that defined in the product model. |
| deviceConfig | Optional | DeviceConfigDTO | body | Indicates device configuration information. For details, see DeviceConfigDTO structure. |
| region | Optional | String(1-256) | body | Indicates the region information about the device. |
| organization | Optional | String(1-256) | body | Indicates the organization to which the device belongs. |
| timezone | Optional | String(1-256) | body | Indicates the time zone where the device is located. The time zone code is used. For example, the time zone code of Shanghai time zone is Asia/Shanghai. |
| ip | Optional | String(128) | Body | Indicates the device IP address. |
| isSecure | Optional | Boolean | body | Indicates the security status of the device. The default value is false.
|
| psk | Optional | String(8-32) | body | Indicates the PSK. The value is a string of characters that consist of only uppercase letters A to F, lowercase letters a to f, and numbers 0 to 9. |
| tags | Optional | List<Tag2> | Body | Indicates the tag of a device. |
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| fieldName | Optional | String(256) | Body | Indicates the field name. |
| fieldType | Optional | String(256) | Body | Indicates the field type. |
| fieldValue | Optional | String(256) | Body | Indicates the field value. |
| Parameter | Mandatory or Optional | Type | Description |
|---|---|---|---|
| dataConfig | Optional | DataConfigDTO | Indicates data configuration information. For details, see DataConfigDTO structure. |
| Parameter | Mandatory or Optional | Type | Description |
|---|---|---|---|
| dataAgingTime | Optional | Integer | Indicates the data aging time. The value range is 0-90. Unit: day. |
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| tagName | Mandatory | String(1-128) | body | Indicates the tag name. |
| tagValue | Mandatory | String(1-1024) | body | Indicates the tag value. |
| tagType | Optional | Integer | body | Indicates the tag type. |
Return Value
void
Error Codes
| HTTP Status Code | Error Code | Error Description | Remarks |
|---|---|---|---|
| 200 | 100203 | The application does not exist. | The application does not exist. Recommended handling:
|
| 400 | 100022 | An input parameter is invalid. | An input parameter is invalid. Recommended handling: Check whether parameters carried in the API call request are valid. |
| 400 | 100440 | The isSecure is invalid. | The value of isSecure is incorrect. |
| 400 | 50400 | An input parameter is invalid. | An input parameter is invalid. Recommended handling: Check whether parameters carried in the API call request are valid. |
| 403 | 100203 | The application does not exist. | The application does not exist. Recommended handling:
|
| 403 | 100217 | The application has not been authorized. | The application has not been authorized. Recommended handling: In scenarios where applications are not authorized, ensure that request parameter appId is null. |
| 403 | 1010009 | The application calls the API at a frequency that exceeds the flow control threshold. | The application calls the API at a frequency that exceeds the flow control threshold (100 calls per minute by default). Recommended handling: Contact IoT platform maintenance personnel to adjust the flow control threshold or control the API call frequency. |
| 403 | 1010005 | Invalid access token or application ID. | The access token is invalid. Recommended handling: Check whether accessToken carried in the API request is correct. |
| 403 | 500004 | The number of frozen devices has reached the upper limit. | The number of frozen devices has reached the upper limit. |
| 404 | 100403 | The device does not exist. | The device does not exist. Recommended handling: Check whether deviceId is correct. |
| 404 | 100418 | The device data does not exist. | The device data does not exist. Recommended handling:
|
| 500 | 100203 | The application does not exist. | The application does not exist. Recommended handling:
|
| 500 | 100441 | The number of non-security devices has reached the upper limit. | The number of non-security devices has reached the upper limit. |
| 500 | 50252 | Internal server error. | An internal server error occurs. Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel. |
Last Article: Refreshing a Device Secret
Next Article: Deleting a Device
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.