调用该接口绑定云存储订单到当前设备管理员账号。
路径 | /vision/customer/cloudstorage/bind/order |
版本号 | 1.0.0 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 可选 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
iotId | String | 是 | QIuozfUcxRX6frOTO4dKz2**** | 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
orderId | String | 是 | 202210131******040001 | 订单ID。 |
userName | String | 否 | 1581053**** | 购买云存储套餐的用户名。可传用户注册手机号、生活物联网平台的用户身份ID、客户自有账号用户ID,云端仅做保存并且在查询的时候返回。 |
userId | String | 否 | 1581053**** | 购买云存储套餐的用户ID。可传用户注册手机号、生活物联网平台的用户身份ID、客户自有账号用户ID,云端仅做保存并且在查询的时候返回。 |
enableDefaultPlan | Boolean | 否 | true | 是否设置默认的7x24小时录像计划和事件录像计划。 |
preRecordDuration | Int | 否 | 5 | 事件录像预录时长,取值范围:0~5秒。 |
recordDuration | Int | 否 | 10 | 事件录像时长,取值范围:0~30秒。 |
eventRecordProlong | Boolean | 否 | false | 是否延长事件录像。true(表示在事件录像过程中,持续触发的事件会延长录像至事件结束);false(表示每个事件固定录制30秒内的录像)。 |
maxRecordFileDuration | Int | 否 | 1800 | 连续录像文件最大的时长,单位:秒。取值600~3600。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
|
data | JSON |
响应的结果。 |
|
iotId | String |
设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
|
identityId | String |
用户身份ID,生活物联网平台为每个注册用户颁发的用户身份标识符。 |
|
commodityCode | String |
云存储套餐编码。 |
|
specification | String |
云存储套餐规格。 |
|
copies | Int |
购买的数量。 |
|
price | String |
订单价格。 |
|
userName | String |
购买云存储套餐的用户名。 |
|
userId | String |
购买云存储套餐的用户ID。 |
|
orderId | String |
购买云存储套餐的订单ID。 |
|
outOrderNo | String |
外部支付结算订单号。阿里云账号下的订单号。 |
|
status | Int |
云存储套餐订单的状态。0(订单有效,使用中);1(订单无效,已过期);2(订单冻结停用);3(创建中,未支付开通)。 |
|
paymentStatus | Int |
云存储订单支付状态。0(未支付);1(已支付);2(正在支付中)。 |
|
recordType | Int |
云存储录像类型,1(连续型);2(事件型)。 |
|
orderType | Int |
订单类型。0(付费订单);1(免费订单)。 |
|
startTime | String |
云存储套餐开始时间。如:2022-10-11 10:00:00。 |
|
endTime | String |
云存储套餐结束时间。如:2022-11-11 10:00:00。 |
|
startTimeUTC | String |
云存储套餐开始时间(UTC)。如:2022-10-11T02:00:00Z。 |
|
endTimeUTC | String |
云存储套餐结束时间(UTC)。如:2022-11-11T02:00:00Z。 |
|
preConsume | Int |
已消耗的时间,单位秒。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.0"
},
"params":{
"iotId": "QIuozfUcxRX6frOTO4dKz2****",
"orderId": "202210131******040001",
"userName": "1581053****",
"userId": "1581053****",
"enableDefaultPlan":true,
"preRecordDuration":5,
"recordDuration":10,
"eventRecordProlong":false,
"maxRecordFileDuration":1800
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": null
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}