调用该接口领取赠送的云存储套餐。
路径 | /vision/customer/cloudstorage/presented/consume |
版本号 | 2.1.5 |
协议 | HTTP,HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
iotId | String | 是 | 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 | |
enableDefaultPlan | Boolean | 否 | 是否设置7*24小时默认计划,默认值为false。 | |
preRecordDuration | Int | 否 | 事件录像预录时长,取值范围:0秒~5秒。 | |
recordDuration | Int | 否 | 事件录像时长,取值范围:0秒~30秒。 | |
quota | Int | 否 | 使用云存储配额,单位:月。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
|
data | JSON |
响应结果。 |
|
type | Int |
云存储套餐类型。1(表示连续型);2(表示事件型)。 |
|
lifecycle | Int |
数据在云端的存储周期,单位:天。取值为:1、3、7、30。 |
|
months | Int |
云存储服务有效期,单位:月。 |
|
consumed | Int |
是否已领取。0(表示未领取);1(表示已领取)。 |
|
startTime | String |
开始时间,格式为yyyy-MM-dd HH:mm:ss。 |
|
endTime | String |
结束时间,格式为yyyy-MM-dd HH:mm:ss。 |
|
expired | Int |
云存储服务是否已到期。0(表示未到期);1(表示已到期)。 |
|
startTimeUTC | String |
开始的UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
|
endTimeUTC | String |
结束的UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
|
remainQuota | Int |
云存储剩余配额,单位:月。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "2.1.5",
"iotToken": "token"
},
"params":{
"iotId": "value0",
"enableDefaultPlan": "value1",
"preRecordDuration": "value2",
"recordDuration": "value3",
"quota": "value4"
}
}
正常返回示例
JSON
格式
{
"code": 200,
"data": {
"lifecycle": 7,
"consumed": 1,
"months": 3,
"expired": 0,
"type": 2,
"startTime": "2019-06-25 17:46:41",
"endTime": "2019-09-25 17:46:41",
"startTimeUTC": "2019-06-25 9:46:41",
"endTimeUTC":"2019-09-25 9:46:41",
"remainQuota": 0
},
"localizedMsg": "success",
"message": "success"
}
异常返回示例
JSON
格式
{
"id": "cfa58de4-6ec9-4069-954b-34972962c411",
"code": 401,
"message": "auth error",
"localizedMsg": "请求认证错误",
"data": null
}