deviceCloudList (deviceCloudList - Query Cloud Storage Services Under Device Channel - Imou Open Platform)

deviceCloudList: deviceCloudList - Query Cloud Storage Services Under Device Channel - Imou Open Platform

Function details

Get all cloud storage services opened under a certain device channel of the developer.

Request address

https://openapi-[DataCenter].easy4ip.com/openapi/deviceCloudList

Request format

HTTP POST. JSON body layout: Request conventions. Sign with Signature.

The minimum permissions required for sub-account token request

"Permission":"RecordReplay" "Resource":"cam:serial number:channel number"

Incoming parameter description

Parameter name	Parameter type	Required or not	Parameter description
token	String	Yes	Administrator or sub-account accessToken
deviceId	String	Yes	Device serial number
channelId	String	Yes	Channel ID

Sample input

{
 "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1599031074,
 "nonce":"8ec8a7bd1d1c95420de20d92422d457d"
 },
 "params":{
 "token":"At_12345678901234567890123456789012",
 "deviceId":"TESTQWERXXXX",
 "channelId":"0"
 }
}

Return data field description

Field	Type	Description
strategies.deviceCloudId	String	Cloud storage unique id
strategies.recordSaveDays	String	Number of days to save video
strategies.strategyId	String	Cloud storage strategy id
strategies.useStatus	Integer	Currently using cloud storage status, 1-cloud storage is on, 0-cloud storage is off
strategies.cloudStatus	Integer	Cloud storage package usage status, 1-in use, 2-queue status, 3-package expired
strategies.cloudType	Integer	Package charge type, 1-charged package, 2-normal free package with end time of existence, 3-permanent free package
strategies.startTime	String	Start time of cloud storage package, format 2019/05/10
strategies.endTime	String	The end time of the cloud storage package, the format is 2020/05/09, the endTime of the permanent free package can be empty
strategies.validDays	Integer	The remaining valid days, a positive number means the remaining days, -1 means not used

Sample output

{
 "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Successful operation",
 "data": {
 "strategies":[ {
 "deviceCloudId": "100001",
 "recordSaveDays":"3",
 "strategyId": "3",
 "useStatus": 1,
 "cloudStatus": 1,
 "cloudType": 1,
 "startTime": "2019/05/10",
 "endTime": "2020/05/09",
 "validDays": 364
 }]
 }
 }
}

Error codes

This method may return the codes below. See Return codes and Capability errors for the full catalog.

Gateway and auth (SN / TK / OP)

Code	Meaning	Next step
`SN1001`	Signature error	Check `sign` per Development specification
`TK1002`	Token invalid or expired	Refresh accessToken
`OP1002`	Missing required parameter	Add required fields
`OP1003`	Invalid parameter	Match this page’s parameter table
`OP1009`	Permission denied	Check token and device bind/share grants
`OP1013`	Total call limit exceeded	Reduce call rate
`OP1014`	Daily per-interface limit exceeded	See Interface call limits
`DV1007`	Device offline	Wait until the device is online

See Return codes · OP/SN/TK for the full catalog.

Sub-accounts (SUB)

Code	Meaning	Next step
`SUB1001`–`SUB1002`	Sub-account lacks API permission	Update policy via addPolicy
`SUB1005`	Sub-account token expired	Refresh subAccountToken
`SUB1006`	No device grant for sub-account	Check `Resource` and device serial
`SUB1008`	Sub-account not bound to app	Create and bind the sub-account first

See Return codes · SUB.

Device access and channels (DV10xx)

Code	Meaning	Next step
`DV1007`	Device offline or timeout	Wait for the device to come online
`DV1009`	Device busy	Retry later
`DV1012`	Insufficient share/grant permission	Check sub-account `Permission` / `Resource`
`DV1019`	Capability not supported	Confirm model and capability list
`DV1020`	Channel offline	Check channel status
`DV1026`	Function not supported	Use another API or upgrade firmware
`DV1028`	Not bound or channel missing	Verify `deviceId` / `channelId`

See Return codes · DV.

Cloud storage plans (ST)

Code	Meaning	Next step
`ST1004`	Cloud storage not enabled	openCloudRecord
`ST1005`	Cloud storage expired	Renew or change plan
`ST1006`	Plan does not exist	Verify strategyId
`ST1009`	Paid plan still active	Handle existing plan first
`ST1010`	Device does not support plan	Choose a supported plan

See Return codes · ST.