接口列表

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

接口列表如下:

序号 接口功能 描述
1 使用卡密给设备开通云存储 使用萤石云存储卡密给设备开通云存储功能
2 查询设备云存储信息 查询设备云存储相关信息
3 开启或关闭设备云存储 开启或关闭设备云存储
4 使用余额给设备开通云存储 使用余额给设备开通云存储功能
5 获取设备可开通的云存储 获取设备可以开通的云存储类型及价格
6 试用云存储 设备试用云存储
7 同一个账号下设备间云存储转移 账号下设备间的云存储转移
8 获取设备云存储信息 获取设备当前云存储信息
9 获取设备云存储是否开通中 获取设备是否有开通中的云存储

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

  • 接口功能:

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

  • 请求地址

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

  • 请求方式

    POST

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

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

  • 请求参数
参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 开通云存储用户的设备序列号,存在英文字母的设备序列号,字母需为大写 Y
cardPassword String 云存储卡卡密 Y
phone String 开通云存储用户的手机号,非必选参数,为空表示为当前用户开通云存储 N
channelNo int 非必选参数,不为空表示给指定通道开通云存储,为空表示给设备本身开通云存储,默认是1 N
isImmediately int 是否立即开通:0-否,1-是,默认是0
为0表示不立即开通,当前云存储服务结束后再开始;为1表示立即开通,会覆盖当前云存储服务
N
  • 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":"操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10004 用户不存在
10005 appKey异常 appKey被冻结
20002 设备不存在
20014 deviceSerial不合法
20018 该用户不拥有该设备 phone对应用户不拥有该设备
20032 该用户下通道不存在 该用户下通道不存在
49999 数据异常 接口调用异常
60012 未知错误 设备返回其他错误码或操作异常
60020 设备不支持云存储 设备不支持云存储或设备当前版本不支持云存储,升级后可支持
60030 卡密输入错误次数过多,24小时后再输入 卡密输入错误次数超过限制次数
60031 卡密信息不存在 确认输入的卡密是否正确
60032 卡密状态错误 卡密未激活或已使用或已过期
60033 卡密非卖品,只能开通对应的绑定设备 非卖品类型卡密
60035 开通云存储服务失败 出现此错误码或者“开通云存储参数错误”的提示请及时发送手机号、设备序列号、卡密密码等信息到open-team@hikvision.com

查询设备云存储信息

  • 接口功能

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

  • 请求地址

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

  • 请求方式

    POST

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写 Y
channelNo int 非必选参数,不为空表示操作指定通道云存储,为空表示操作设备本身云存储,默认是1 N
  • 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,
            "cloudStorageServiceList": [
                {
                    "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": "操作成功!"
}
  • 返回字段:
字段名 类型 描述
deviceSerial String 设备序列号
username String 用户名
channelNo int 设备通道号
totalDays int 存储时长
userEnable int 当前云存储服务状态 1:开启 0:暂停
serviceTime int 当前云存储的服务时长
serviceTimeUnit int 当前云存储的服务时间单位 1:天 2:周 3:月 4:年
storageTime int 当前云存储的存储时长
storageTimeUnit int 当前云存储的存储时间单位 1:天 2:周 3:月 4:年
cloudStorageServiceList Array 云存储服务对象 ,包含所有可用的云存储
bussinessOrderId int 订单号
productPayType int 产品付费类型 1:付费 2:试用
effectTime long 生效时间,时间戳
expireTime long 过期时间,时间戳
status int 云存储状态 1:待使用 2:使用中
userActiveStatus int 用户激活状态 1:激活状态 2:暂停状态
effectImmediately int 服务是否立即生效 1:立即生效 2:延迟生效
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10004 用户不存在
10005 appKey异常 appKey被冻结
10013 非开发者账户无权限调用
20002 设备不存在
20006 网络异常
20007 设备不在线
20008 设备响应超时 设备网络不佳,稍候请重试
20014 deviceSerial不合法
20018 该用户不拥有该设备 用户不拥有该设备
49999 数据异常 接口调用异常

开启或关闭设备云存储

  • 接口功能

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

  • 请求地址

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

  • 请求方式

    POST

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

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

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 开通云存储用户的设备序列号,存在英文字母的设备序列号,字母需为大写 Y
enable int 开启或关闭云存储:0-关闭,1-开启 Y
phone String 开通云存储用户的手机号,非必选参数,为空表示为当前用户开通云存储 N
channelNo int 非必选参数,不为空表示操作指定通道云存储,为空表示操作设备本身云存储,默认是1 N
  • 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": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10004 用户不存在
10005 appKey异常 appKey被冻结
20002 设备不存在
20006 网络异常
20007 设备不在线
20008 设备响应超时 设备网络不佳,稍候请重试
20014 deviceSerial不合法
20018 该用户不拥有该设备 phone对应用户不拥有该设备
49999 数据异常 接口调用异常
60012 未知错误 设备返回其他错误码或操作异常

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

  • 接口功能

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

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

  • 请求地址

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

  • 请求方式

    POST

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 开通云存储用户的设备序列号,存在英文字母的设备序列号,字母需为大写 Y
channelNo int 非必选参数,不为空表示操作指定通道云存储,为空表示操作设备本身云存储,默认是1 Y
isImmediately int 是否立即开通:0-否,1-是,默认是0.
为0表示不立即开通,当前云存储服务结束后再开始;为1表示立即开通,如果存在云服务且云服务类型一致则在当前云服务上续期,如果不一致直接覆盖当设备存在延迟生效的云存储时, 该参数选择立即开通时, 设备的云存储会全部被覆盖,只剩下新开通的云存储
N
cloudType String 云存储类型,需要由 ( 获取设备可开通的云存储类型 ) 接口获取 Y
requestId String 请求ID,建议使用UUID, 注:相同的请求ID会被认为是同一个请求 Y
  • 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": "操作成功!"
}
  • 返回字段:
字段名 类型 描述
orderId String 订单ID
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10004 用户不存在
10005 appKey异常 appKey被冻结
10013 非开发者账户无权限调用
10052 余额不足
10053 云存储开通中 云存储服务开通有延迟,正在开通后续可以通过( 查询设备当前云存储状态) 进行判断
10054 云存储操作异常
10060 设备不支持的云存储类型 cloudType错误
20002 设备不存在
20006 网络异常
20007 设备不在线
20008 设备响应超时 设备网络不佳,稍候请重试
20014 deviceSerial不合法
20018 该用户不拥有该设备 用户不拥有该设备
49999 数据异常 接口调用异常

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

  • 接口功能

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

  • 请求地址

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

  • 请求方式

    POST

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写 Y
channelNo int 非必选参数,不为空表示操作指定通道云存储,为空表示操作设备本身云存储,默认是1 N
  • 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": "操作成功!"
}
  • 返回字段:
字段名 类型 描述
cloudProductName String 云存储套餐名称
cloudType String 云存储类型
serviceTime int 云存储 服务时长
serviceTimeUnit int 云存储 服务时间单位 1:天 2:周 3:月 4 年
storageTime int 云存储 存储时长
storageTimeUnit int 云存储 存储时间单位 1:天 2:周 3:月 4 年
price int 云存储服务价格 单位 分
productStatus int 云存储套餐状态 1:启用 0:停用
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10004 用户不存在
10005 appKey异常 appKey被冻结
10013 非开发者账户无权限调用
10054 云存储操作异常
20002 设备不存在
20006 网络异常
20007 设备不在线
20008 设备响应超时 设备网络不佳,稍候请重试
20014 deviceSerial不合法
20018 该用户不拥有该设备 用户不拥有该设备
49999 数据异常 接口调用异常

试用云存储

  • 接口功能

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

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

  • 请求地址

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

  • 请求方式

    POST

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 试用云存储的设备序列号,存在英文字母的设备序列号,字母需为大写 Y
channelNo int 非必选参数,不为空表示操作指定通道云存储,为空表示操作设备本身云存储,默认是1 N
requestId String 请求ID, 建议UUID, 注:相同的请求ID会被认为是同一个请求 Y
  • 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": "操作成功!"
}
  • 返回字段:
字段名 类型 描述
orderId String 订单号
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10004 用户不存在
10005 appKey异常 appKey被冻结
10013 非开发者账户无权限调用
10054 云存储操作异常
10055 设备不支持云存储
10059 requestId已存在
20002 设备不存在
20006 网络异常
20007 设备不在线
20008 设备响应超时 设备网络不佳,稍候请重试
20014 deviceSerial不合法
20018 该用户不拥有该设备 用户不拥有该设备
49999 数据异常 接口调用异常

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

  • 接口功能

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

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

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

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

  • 请求地址

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

  • 请求方式

    POST

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
fromDeviceSerial String 云存储转出设备的设备序列号,存在英文字母的设备序列号,字母需为大写 Y
fromChannelNo int 非必选参数,不为空表示操作指定通道云存储,为空表示操作设备本身云存储,默认是1 N
toDeviceSerial String 云存储转入设备的设备序列号 Y
toChannelNo int 非必选参数,不为空表示操作指定通道云存储,为空表示操作设备本身云存储,默认是1 N
requestId String 请求ID, 建议UUID, 注:相同的请求ID会被认为是同一个请求 Y
  • 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": "操作成功!"
}
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10004 用户不存在
10005 appKey异常 appKey被冻结
10013 非开发者账户无权限调用
10054 云存储操作异常
10056 设备不支持云存储服务转出 当前设备无云存储服务 或 当前设备在线且云存储服务为启用状态
10057 设备不支持云存储服务转入 云存储转入设备不在线 或 转入设备中存在可用的云存储
10058 两台设备间云存储不支持转移
10059 requestId已存在
20002 设备不存在
20006 网络异常
20007 设备不在线
20008 设备响应超时 设备网络不佳,稍候请重试
20014 deviceSerial不合法
20018 该用户不拥有该设备 用户不拥有该设备
49999 数据异常 接口调用异常

获取设备云存储信息

  • 接口功能

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

  • 请求地址

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

  • 请求方式

    POST

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

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

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 开通云存储用户的设备序列号,存在英文字母的设备序列号,字母需为大写 Y
phone String 开通云存储用户的手机号,非必选参数 N
channelNo int 非必选参数,不为空表示查询指定通道云存储信息,为空表示查询设备本身云存储信息,默认是1 N
  • 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": "操作成功!"
}
  • 返回字段:
字段名 类型 描述
userName String 云存储服务所属用户的用户名
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写
channelNo int 通道号
totalDays int 云存储服务录像覆盖周期
status int 云存储状态,-2:设备不支持,-1:未开通云存储,0:未激活,1:激活,2:过期
validDays int 可用天数
startTime long 云存储服务开始时间,精确到秒
expireTime long 云存储服务结束时间,精确到秒
serviceDetail Object 不同类型云存储服务信息,只有当设备存在两种类型云存储服务才会有此对象
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10004 用户不存在
10005 appKey异常 appKey被冻结
20002 设备不存在
20014 deviceSerial不合法
20018 该用户不拥有该设备 phone对应用户不拥有该设备
49999 数据异常 接口调用异常
60012 未知错误 设备返回其他错误码或操作异常

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

  • 接口功能

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

  • 请求地址

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

  • 请求方式

    POST

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号,字母需为大写 Y
channelNo int 非必选参数,不为空表示操作指定通道云存储,为空表示操作设备本身云存储,默认是1 N
  • 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": "操作成功!"
}
  • 返回字段:
字段名 类型 描述
isOpening int 是否有开通中的云存储 0:否 1:是
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken异常或过期 重新获取accessToken
10004 用户不存在
10005 appKey异常 appKey被冻结
10013 非开发者账户无权限调用
20002 设备不存在
20006 网络异常
20007 设备不在线
20008 设备响应超时 设备网络不佳,稍候请重试
20014 deviceSerial不合法
20018 该用户不拥有该设备 用户不拥有该设备
49999 数据异常 接口调用异常

results matching ""

    No results matching ""