调用该接口设置用户的云存储套餐状态。
路径 | /vision/customer/cloudstorage/status/set |
版本号 | 1.0.1 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 可选 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
iotId | String | 是 | aD12ef8Kk****EiNJJ001082 | 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
orderId | String | 是 | 20221102165******0001 | 云存储订单ID。 |
status | Int | 是 | 0 | 云存储订单状态,2(表示冻结停用)。 |
deviceNoOwner | Boolean | 否 | false | 支持设备解绑了用户的状态下冻结之前购买的订单。如果为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。 |
|
startTimeUTC | String |
开始时间UTC。 |
|
endTimeUTC | String |
结束时间UTC。 |
|
expired | Int |
订单状态,0(表示未到期);1(表示已到期);2(表示冻结)。 |
|
paymentStatus | Int |
支付状态。0(表示未支付);1(表示已支付)。 |
|
price | String |
云存储套餐价格。单位:元。 |
|
commodityType | Int |
云存储类型。1(表示连续型);2(表示事件型)。 |
|
iotId | String |
设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
|
identityId | String |
用户身份ID,生活物联网平台为每个注册用户颁发的用户身份标识符。 |
|
status | Int |
订单状态,0(表示未到期);1(表示已到期);2(表示冻结)。 |
|
preConsume | Int |
已消耗的时间,单位秒。 |
|
outOrderNo | String |
外部支付结算订单号。阿里云账号下的订单号。 |
|
orderType | Int |
订单类型。0(付费订单);1(免费订单)。 |
|
userName | String |
购买云存储套餐的用户名。 |
|
userId | String |
购买云存储套餐的用户ID。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.1"
},
"params":{
"iotId": "aD12ef8Kk****EiNJJ001082",
"orderId": "20221102165******0001",
"status":0,
"deviceNoOwner":false
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": {
"orderId": "123",
"commodityCode": "124",
"specificattion":"streamResource_7",
"copies": 1,
"startTime": "2020-04-22 09:00:00",
"endTime": "2020-05022 09:00:00",
"startTimeUTC": "2020-04-22T01:00:00Z",
"endTimeUTC": "2020-05-22T01:00:00Z",
"expired": 0,
"paymentStatus": 1,
"price": "1.2",
"commodityType": 1
}
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}