接口列表

本节包含云存储、云空间相关接口等。

接口列表如下：

使用卡密给设备开通云存储

• 接口功能：

  该接口用于使用萤石云存储卡密给设备开通云存储功能。（购买云存储卡密）

• 请求地址

  https://open.ys7.com/api/lapp/cloud/storage/open

• 请求方式

  POST

• 子账户token请求所需最小权限

  "Permission":"Config" "Resource":"dev:序列号"

• 请求参数

• HTTP请求报文

POST /api/lapp/cloud/storage/open HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.4fal4i1y0er1bw476c5z53f63dsjkwrl&deviceSerial=596510666&channelNo=1&phone=18888888888&cardPassword=4326717075050976&isImmediately=0

• 返回数据

{
    "code":"200",
    "msg":"操作成功!"
}

• 返回码

查询设备云存储信息

• 接口功能

  该接口用于设备当前的云存储信息

• 请求地址

  https://open.ys7.com/api/lapp/cloud/v2/storage/device/info

• 请求方式

  POST

• 请求参数

• HTTP请求报文

POST /api/lapp/cloud/v2/storage/device/info HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.d8yk9c2u1i7nkzmfa6a50xoy83h79mn5-1amk08c44c-1yil9gp-thiokhmk9&deviceSerial=LL0000001&channelNo=1

• 返回数据

{
    "data": [
        {
            "deviceSerial": "519928976",
            "channelNo": 1,
            "userId": "niuxiaoge",
            "totalDays": 7,
            "userEnable": 1,
            "serviceType": "3",
            "expireTime": 1540809058000,
            "serviceTime": 1,
            "serviceTimeUnit": 3,
            "storageTime": 7,
            "storageTimeUnit": 1,
            "cloudStorageServiceRespList": [
                {
                    "businessOrderId": "open_1_20180929183058069_21694a5ab297ddec",
                    "businessSource": 2,
                    "businessBuyNum": 1,
                    "serviceTime": 1,
                    "serviceTimeUnit": 3,
                    "storageTime": 7,
                    "storageTimeUnit": 1,
                    "productPayType": 1,
                    "effectTime": 1538216758000,
                    "expireTime": 1540809058000,
                    "createTime": 1538217058000,
                    "updateTime": 1538217322000,
                    "status": 2,
                    "userActiveStatus": 1,
                    "forceBinding": 2,
                    "effectImmediately": 1
                }
            ]
        }
    ],
    "code": "200",
    "msg": "操作成功!"
}

• 返回字段：

• 返回码

开启或关闭设备云存储

• 接口功能

  该接口用于开启或关闭设备云存储

• 请求地址

  https://open.ys7.com/api/lapp/cloud/storage/enable

• 请求方式

  POST

• 子账户token请求所需最小权限

  "Permission":"Config" "Resource":"Cam:序列号:通道号"

• 请求参数

• HTTP请求报文

POST /api/lapp/cloud/storage/enable HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.4fal4i1y0er1bw476c5z53f63dsjkwrl&deviceSerial=596510666&channelNo=1&phone=18888888888&enable=1

• 返回数据

{
    "code": "200",
    "msg": "操作成功!"
}

• 返回码

使用账户余额给设备开通云存储服务

• 接口功能

  该接口用于使用账户余额给指定用户的设备开通云存储

  该接口目前只支持给开发者账号使用 云存储开通存在延迟, 立即开通前 建议先调用 ( 获取设备云存储是否开通中 和 获取设备云存储信息 ) 两个接口判断设备是否有云存储服务

• 请求地址

  https://open.ys7.com/api/lapp/cloud/storage/service/open

• 请求方式

  POST

• 请求参数

• HTTP请求报文

POST /api/lapp/cloud/storage/service/open HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.d8yk9c2u1i7nkzmfa6a50xoy83h79mn5-1amk08c44c-1yil9gp-thiokhmk9&deviceSerial=LL0000001&channelNo=1&isImmediately=1&cloudType=400299958&requestId=32

• 返回数据

{
    "data": {
        "orderId": "open_1_20180929150542808_19924c8789c69a5b"
    },
    "code": "200",
    "msg": "操作成功!"
}

• 返回字段：

• 返回码

获取设备可开通的云存储类型

• 接口功能

  该接口用于获取设备可以开通的云存储类型,以及对应的价格

• 请求地址

  https://open.ys7.com/api/lapp/cloud/storage/device/support

• 请求方式

  POST

• 请求参数

• HTTP请求报文

POST /api/lapp/cloud/storage/device/support HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.d8yk9c2u1i7nkzmfa6a50xoy83h79mn5-1amk08c44c-1yil9gp-thiokhmk9&deviceSerial=519928976&channelNo=1

• 返回数据

{
    "data": [
        {
            "cloudProductName": "7天循环月套餐",
            "cloudType": "400299958",
            "serviceTime": 1,
            "serviceTimeUnit": 3,
            "storageTime": 7,
            "storageTimeUnit": 1,
            "price": 1200
        }
    ],
    "code": "200",
    "msg": "操作成功!"
}

• 返回字段：

• 返回码

试用云存储

• 接口功能

  该接口用于给第一次使用云存储的设备,试用云存储

  设备支持试用云存储的条件是设备没有使用过云存储, 多通道设备只要有一个通道使用过云存储,其他通道也不能进行试用

• 请求地址

  https://open.ys7.com/api/lapp/cloud/storage/trial

• 请求方式

  POST

• 请求参数

• HTTP请求报文

POST /api/lapp/cloud/storage/trail HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.d8yk9c2u1i7nkzmfa6a50xoy83h79mn5-1amk08c44c-1yil9gp-thiokhmk9&deviceSerial=519928976&channelNo=1&requestId=123465

• 返回数据

{
    "data": {
        "orderId": "open_1_20180929150545808_19924c8782369a5b"
    },
    "code": "200",
    "msg": "操作成功!"
}

• 返回字段：

• 返回码

同一个账号下设备间云存储转移

• 接口功能

  该接口用于云存储在同一个账号下两个设备之间转移

  注1: 云存储转移针设备下所有云存储, 无法进行单个云存储服务的转移

  云存储转出条件 : 设备中存在可用的云存储, 且云存储没有在使用
                 (即 1:设备存在云存储  2: 云存储 停用 或设备不在线)
  云存储转入条件 : 设备在线 ,且没有可用的云存储
                 (即 设备云存储全部过期, 或未使用过云存储)
  

  注2: 设备云存储转移后 默认为停用状态, 但是状态显示可能不正确, 建议用户启用停用一次

• 请求地址

  https://open.ys7.com/api/lapp/cloud/storage/trans

• 请求方式

  POST

• 请求参数

• HTTP请求报文

POST /api/lapp/cloud/storage/trans HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.d8yk9c2u1i7nkzmfa6a50xoy83h79mn5-1amk08c44c-1yil9gp-thiokhmk9&fromDeviceSerial=LL0000001&fromChannelNo=1&toDeviceSerial=686220334&toChannelNo=1

• 返回数据

{
    "code": "200",
    "msg": "操作成功!"
}

• 返回码

获取设备云存储信息

• 接口功能

  该接口用于查询设备云存储相关信息（该接口不支持NVR）

• 请求地址

  https://open.ys7.com/api/lapp/cloud/storage/device/info

• 请求方式

  POST

• 子账户token请求所需最小权限

  "Permission":"Get" "Resource":"Cam:序列号:通道号"

• 请求参数

• HTTP请求报文

POST /api/lapp/cloud/storage/device/info HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.4fal4i1y0er1bw476c5z53f63dsjkwrl&deviceSerial=596510666&channelNo=1&phone=18888888888

• 返回数据

{
    "data": {
        "userName": "ezviz",
        "deviceSerial": "596510666",
        "channelNo": 1,
        "totalDays": 7,
        "status": 1,
        "validDays": 280,
        "startTime": 1470370451000,
        "expireTime": 1603107852000,
        "serviceDetail": {
            "userName": "ezviz",
            "deviceSerial": "596510666",
            "channelNo": 1,
            "totalDays": 30,
            "startTime": 1539949152000,
            "expireTime": 1603107852000,
            "status": 0
        }
    },
    "code": "200",
    "msg": "操作成功!"
}

• 返回字段：

• 返回码

获取设备云存储是否开通中

• 接口功能

  该接口用于 获取设备云存储是否正在开通中

• 请求地址

  https://open.ys7.com/api/lapp/cloud/storage/service/open/info

• 请求方式

  POST

• 请求参数

• HTTP请求报文

POST /api/lapp/cloud/v2/storage/device/info HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.d8yk9c2u1i7nkzmfa6a50xoy83h79mn5-1amk08c44c-1yil9gp-thiokhmk9&deviceSerial=LL0000001&channelNo=1

• 返回数据

{
    "data": {
        "isOpening": 0
    },
    "code": "200",
    "msg": "操作成功!"
}

• 返回字段：

• 返回码