mdiInDto

Mandatory

ModifyDeviceInfoInDTO

body

For details, see ModifyDeviceInfoInDTO structure.

deviceId

Mandatory

String

path

Identifies a device. The device ID is allocated by the platform during device registration.

appId

Optional

String

query

If the device belongs to the current application, set this parameter to None. Otherwise, set this parameter to the ID of the authorized application.

accessToken

Mandatory

String

header

This parameter is set to the value of the accessToken obtained by calling the Authentication API.

customFields

Optional

List<CustomField>

Body

Customized field list.

deviceConfig

Optional

DeviceConfigDTO

body

Indicates device configuration information.

deviceType

Optional

String(1~256)

body

Indicates the device type. The upper camel case is used, for example, MultiSensor, ContactSensor, and CameraGateway.

After registering a device, you must change the device type to be the same as that defined in the product model.

endUser

Optional

String(1~256)

body

Indicates an end user. If the device is a directly connected device, this parameter is optional. If it is an indirectly connected device, this parameter can be set to null.

location

Optional

String(1~1024)

body

Indicates the device location.

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.

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.

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.

• TRUE: The device is in the frozen state.
• FALSE: The device is not in the frozen state.

name

Optional

String(1~256)

body

Indicates the device name.

organization

Optional

String(1~256)

body

Indicates the organization to which the device belongs.

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.

region

Optional

String(1~256)

body

Indicates the region information about the device.

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.

imsi

Optional

String(1-64)

Body

Indicates the IMSI of an NB-IoT device.

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.

• true: The device is secure.
• false: The device is not secure.

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.

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.

dataConfig

Optional

DataConfigDTO

Indicates the data configuration information.

dataAgingTime

Optional

Integer

Indicates the data aging time. The value range is 0-90. Unit: day.

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.

200

100203

The application does not exist.

The application does not exist.

Recommended handling:

• Check whether appId carried in the HTTP request header is correct.
• Check whether appId in the request path (URL) is correct.

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:

• Check whether appId carried in the HTTP request header is correct.
• Check whether appId in the request path (URL) is correct.

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:

• If deviceId carried in the request is incorrect, check whether deviceId belongs to appId or whether deviceId is incorrect.
• Check whether appId carried in the header contains deviceId.
• If the URL contains the optional parameter appId, check whether the value of appId is correct.

500

100203

The application does not exist.

The application does not exist.

Recommended handling:

• Check whether appId carried in the HTTP request header is correct.
• Check whether appId in the request path (URL) is correct.

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.