调用该接口将用户已购买的云存储套餐转移。当前仅支持将云存储套餐从同一个管理员账号下的一个设备转移到另一个设备。
路径 | /vision/customer/cloudstorage/transfer |
版本号 | 1.0.0 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 可选 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
srcIotId | String | 是 | 云存储套餐待转移设备ID。 | |
srcOrderId | String | 是 | 购买云存储套餐的订单ID。 | |
dstIotId | String | 是 | 云存储套餐转移目标设备ID。 | |
enableDefaultPlan | Boolean | 否 | 是否设置7*24小时录像计划和事件录像计划。 | |
immediateUse | Boolean | 否 | 是否设置为立即生效。true(表示立即生效);false(表示在之前套餐到期后生效)。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
|
data | JSON |
响应的结果。 |
|
orderId | String |
订单ID。 |
|
commodityCode | String |
云存储套餐编号。 |
|
specification | String |
云存储套餐规格。 |
|
copies | Int |
购买数量。 |
|
startTime | String |
开始时间,格式为yyyy-MM-dd HH:mm:ss。 |
|
endTime | String |
结束时间,格式为yyyy-MM-dd HH:mm:ss。 |
|
expired | Int |
是否到期。0(表示未到期);1(表示已到期)。 |
|
paymentStatus | Int |
支付状态。0(表示未支付);1(表示已支付)。 |
|
price | String |
订单价格,单位:元。 |
|
commodityType | Int |
云存储套餐类型。1(表示连续型);2(表示事件型)。 |
|
startTimeUTC | String |
开始时间(UTC),格式为yyyy-MM-ddTHH:mm:ssZ。 |
|
endTimeUTC | String |
结束时间(UTC),格式为yyyy-MM-ddTHH:mm:ssZ。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.0"
},
"params":{
"srcIotId": "value0",
"srcOrderId": "value1",
"dstIotId": "value2",
"enableDefaultPlan": "value3",
"immediateUse": "value4"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": ""
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}
在文档使用中是否遇到以下问题
更多建议
匿名提交