调用该接口领取免费的云存储套餐。

路径 /vision/customer/freecloudstorage/consume
版本号 1.0.4
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权 可选
超时时间 3000

请求参数

名称类型是否必选示例值描述
名称 类型 是否必选 示例值 描述
iotId String 是 QIuozfUcxRX6frOTO4dKz2**** 设备ID，生活物联网平台为设备颁发的ID，设备的唯一标识符。
enableDefaultPlan Boolean 否 true 是否设置7x24小时默认连续录像计划和事件录像计划。
immediateUse Boolean 否 true 是否立即使用。true（表示新领取免费套餐立即生效）；false（表示新领取的免费套餐在之前套餐到期后生效）。
preRecordDuration Int 否 5 预录时长，取值范围0～5，单位：秒。
recordDuration Int 否 10 事件录像时长，取值范围0～30，单位：秒。
quota Int 否 3 使用赠送的云存储配额，单位：月。
eventRecordProlong Boolean 否 true 是否延长事件录像。true（表示在事件录像过程中，持续触发的事件会延长录像至事件结束）；false（表示每个事件固定录制30秒内的录像）。

返回数据

名称类型示例值描述
名称 类型 示例值 描述
code Int

接口返回码。200表示成功。
message String

调用失败时，返回的出错信息。
localizedMsg String

本地语言的错误消息。
data JSON

响应结果。
type Int

云存储套餐类型。1（表示连续型）；2（表示事件型）。
lifecycle Int

数据在云端的存储周期，取值：1、3、7、14、30，单位：天。
months Int

云存储服务有效期，单位：月。
consumed Int

是否已领取。0（表示未领取）；1（表示已领取）。
startTime String

开始时间，格式为yyyy-MM-dd HH:mm:ss，如2020-07-30 09:00:00。
endTime String

结束时间，格式为yyyy-MM-dd HH:mm:ss，如2020-08-30 09:00:00。
expired Int

云存储服务是否已到期。0（表示未到期）；1（表示已到期）；2（表示订单冻结停用）。
startTimeUTC String

开始时间(UTC)，格式为yyyy-MM-ddTHH:mm:ssZ，如2020-07-30T01:00:00Z。
endTimeUTC String

结束时间(UTC)，格式为yyyy-MM-ddTHH:mm:ssZ，如2020-08-30T01:00:00Z。
remainQuota Int

赠送的云存储剩余配额，单位：月。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.4"
	},
	"params":{
		"iotId": "QIuozfUcxRX6frOTO4dKz2****",
		"enableDefaultPlan":true,
		"immediateUse":true,
		"preRecordDuration":5,
		"recordDuration":10,
		"quota":3,
		"eventRecordProlong":true
	}
}

正常返回示例

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-25T9:46:41Z",
        "endTimeUTC":"2019-09-25T9:46:41Z",
        "remainQuota": 0
    }, 
    "localizedMsg": "success", 
    "message": "success"
}

异常返回示例

JSON格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}