您现在的位置是:首页 > API接口说明

API接口说明-公开

API接口说明作者:User日期:2025-10-09 10:57:19点击:29
简要描述
  • 获取设备云存状态
请求URL
  • {{base_url}}/storageapi/Device/Status
请求方式
  • POST
参数
参数名 必选 类型 说明
AppId varchar(32) API ID(联系管理人员由系统分配)
Gid varchar(32) 设备唯一标识
Tick bigint 当前时间戳
Sign varchar(32) 数据签名
TokenType int 返回Token类型1为APP,2为Device,0表示不返回
请求参数示例
{
  "AppId": "1000001",
  "Gid": "c40000000000000000001",
  "Sign": "c32ce1cf93e8661c9702a98facdc8622",
  "Tick": 1756700624,
  "Version": "1.0.0.1"
}
TokenType==2时,带设备请求TOken返回示例
{
  "code": 200,
  "msg": "success",
  "Tick": 1758949708,
  "Data": {
    "devno": "t001",
    "storagerid": 7,
    "exptime": "2028-09-17T10:49:40+08:00",
    "status": 1,
    "st_pk_id": 7,
    "is_upload_av": 1,
    "is_upload_pic_alarm": 1,
    "is_upload_pic_724": 1,
    "is_continue": 0,
    "stream_type": 0,
    "save_days": 7,
    "chn_no": "[-1]",
    "owsp_prefix": "7-A-",
    "config_prefix": "7-config-",
    "TokenServer": "cttoken.aiot99.com",
    "TokenServerPort": 9099
  },
  "Token": {
    "AccessKeyId": "N4kYuPuPNLr2IXhJFth",
    "SecretAccessKey": "X1KN7S9XS5B4P7XZTB5URE76G206V7EUFCHZ385",
    "SessionToken": "Xl7iEw2YXS9nyuqH+3wQk8YB8B==",
    "Expiration": "2025-09-27 06:07:44",
    "Bucket": "ct-record",
    "EndPoint": "https://huabei-2.zos.ctyun.cn",
    "CreateTime": "2025-09-27 13:07:44",
    "Gid": "t001"
  }
}
不带TokenType时,返回示例
{
  "code": 200,
  "msg": "success",
  "Tick": 1758949670,
  "Data": {
    "devno": "t001",
    "storagerid": 7,
    "exptime": "2028-09-17T10:49:40+08:00",
    "status": 1,
    "st_pk_id": 7,
    "is_upload_av": 1,
    "is_upload_pic_alarm": 1,
    "is_upload_pic_724": 1,
    "is_continue": 0,
    "stream_type": 0,
    "save_days": 7,
    "chn_no": "[-1]",
    "owsp_prefix": "7-A-",
    "config_prefix": "7-config-", 
    "TokenServer": "cttoken.aiot99.com",
    "TokenServerPort": 9099
  },
  "Token": {
    "AccessKeyId": "",
    "SecretAccessKey": "",
    "SessionToken": "",
    "Expiration": "",
    "Bucket": "",
    "EndPoint": "",
    "CreateTime": ""
    "Gid": "",
  }
}
返回参数说明
参数名 类型 示例 说明
Code int 200 200表示成功,其它表示失败
Tick int64 0 当前系统时间戳,用于请求时间同步
Data Object 云存套餐参数查看后续data对象说明 如果返回成功,则会存在此字段,用于返回当前设备状态
Token Object 可选,传入需要返回Token时才会返回 参数说明见后续
返回状态code状态说明
状态值 描述说明
200 表示成功
401 签名错误,需要检测appid,appkey是否正确
402 时间截与当前系统时间截差异过大,需要先执行时间同步
404 表示传入参数设备GID为空
405 设备云存已无效
406 设备云存已欠费停用
407 设备云存已暂停使用
408 设备云存新开失败
409 设备云存已过期或无效
410 设备未开通云存服务
返回Data对象说明
参数名 说明
devno 设备ID
storagerid 显示云存套餐ID
exptime 云存有效期
status 当前云存状态,1=有效 0=无效 2=欠费停用 3=用户暂停,4 订购新套餐失败
st_pk_id 订单有效期剩下天数
is_upload_av 是否上传音视频 ,0 = 不上传,1 = 上传
is_upload_pic_alarm 是否上传告警图像
is_upload_pic_724 是否上传定时抓拍图像 是否上传图片(7*24小时),0 = 不上传,1 = 上传
is_continue 是否连续套餐,0 = 报警套餐 1 = 连续套餐
stream_type 是否录制子码流 ,码流类型,0 = 主码流 1 = 次码流
save_days 保存天数 , 保存天数,比如7天套餐,则为7
chn_no 开通存储通道列表,字符串”[-1]”表示所有,”[0,1]”表示第1通道和第2通道
owsp_prefix 媒体文件存储前缀
config_prefix 配置文件存储前缀
TokenServer 获取Token的HTTP服务域名地址
TokenServerPort 获取Token的HTTP服务端口
返回Token对象说明
参数名 说明
AccessKeyId 天翼云存临时授权的AK,需要AK、SK、Token一起使用
SecretAccessKey 天翼云存临时授权的SK,需要AK、SK、Token一起使用
SessionToken 天翼云存临时授权的Token,需要AK、SK、Token一起使用
Expiration 当前Token的有效期 ,UTC时间戳
Bucket 云存的Bucket
EndPoint 云存的EndPoint
CreateTime 当前Token的请求时间,UTC时间戳
Gid 设备ID
备注

文章评论