Skip to content

RecordPlan 类接口说明（录制计划）

Jump to bottom
chatop2020 edited this page May 11, 2021 · 3 revisions

RecordPlan 类接口说明

接口索引

序号 接口名称 说明
1 DeleteRecordPlanByName 删除录制计划（通过Name）
2 CreateRecordPlan 创建一个录制计划
3 SetRecordPlanByName 修改一个录制计划(通过Name)
4 OnOrOffRecordPlanByName 启用或者停用一个录制计划(通过Name)
5 GetRecordPlanList 获取录制计划列表

DeleteRecordPlanByName 删除录制计划(通过Name)

  • 作用:删除一个录制计划，条件是录制计划的名称
  • 方法:HttpGet
  • 是否鉴权:是
  • 输入参数:
  • name 录制计划的名称
  • 调用实例:
curl -X GET "http://192.168.2.27:5800/RecordPlan/DeleteRecordPlanByName?name=test" -H  "accept: text/plain"
  • 返回参数:
true/false

CreateRecordPlan 创建一个录制计划

  • 作用:创建一个录制计划
  • 方法:HttpGet
  • 是否鉴权:是
  • 输入参数:
{
  "enable": true, //是否启用
  "name": "string",//录制计划名称
  "describe": "string",//录制计划描述
  "limitSpace": 0,//限制空间大小(byte)
  "limitDays": 0,//限制录制天数
  "overStepPlan": 0,//超过限制条件后的处置方式0:StopDvr(停止录制) 1:DeleteFile（删除文件）,
  "timeRangeList": [//录制周期列表（以周为单位）
    {
      "streamDvrPlanId": 0,//关联录制计划id
      "weekDay": 0,//周几， Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday
      "startTime": "2021-05-11T02:04:43.113Z",//开时录制的时间（与日期无关）
      "endTime": "2021-05-11T02:04:43.113Z"//结束录制的时间（与日期无关）
    }
  ]
}
  • 调用实例:
curl -X POST "http://192.168.2.27:5800/RecordPlan/CreateRecordPlan" -H  "accept: text/plain" -H  "Content-Type: application/json-patch+json" -d "{\"name\":\"test\",\"enable\":true,\"describe\":\"\",\"limitSpace\":9999999999999,\"limitDays\":4,\"overStepPlan\":1,\"timeRangeList\":[{\"id\":78,\"recordPlanId\":16,\"weekDay\":1,\"startTime\":\"2000-01-01 00:00:00\",\"endTime\":\"2000-01-01 23:59:59\"},{\"id\":79,\"recordPlanId\":16,\"weekDay\":2,\"startTime\":\"2000-01-01 00:00:00\",\"endTime\":\"2000-01-01 23:59:59\"},{\"id\":80,\"recordPlanId\":16,\"weekDay\":3,\"startTime\":\"2000-01-01 00:00:00\",\"endTime\":\"2000-01-01 23:59:59\"},{\"id\":81,\"recordPlanId\":16,\"weekDay\":4,\"startTime\":\"2000-01-01 00:00:00\",\"endTime\":\"2000-01-01 23:59:59\"},{\"id\":82,\"recordPlanId\":16,\"weekDay\":5,\"startTime\":\"2000-01-01 00:00:00\",\"endTime\":\"2000-01-01 23:59:59\"},{\"id\":83,\"recordPlanId\":16,\"weekDay\":0,\"startTime\":\"2020-02-01 00:00:00\",\"endTime\":\"2020-02-01 23:59:59\"}]}"
  • 返回参数:
true/false

DeleteRecordPlanByName 删除录制计划(通过Name)

  • 作用:删除一个录制计划，条件是录制计划的名称
  • 方法:HttpGet
  • 是否鉴权:是
  • 输入参数:
  • name 计划的名称
  • 调用实例:
curl -X GET "http://192.168.2.27:5800/RecordPlan/DeleteRecordPlanByName?name=test" -H  "accept: text/plain"
  • 返回参数:
true/false

SetRecordPlanByName 修改一个录制计划(通过Name)

  • 作用:修改一个录制计划，条件是录制计划的名称
  • 方法:HttpPost
  • 是否鉴权:是
  • 输入参数:
  • name 计划的名称
  • 调用实例:
curl -X POST "http://192.168.2.27:5800/RecordPlan/SetRecordPlanByName?name=test" -H  "accept: text/plain" -H  "Content-Type: application/json-patch+json" -d "{\"enable\":true,\"name\":\"test\",\"describe\":\"string\",\"limitSpace\":0,\"limitDays\":0,\"overStepPlan\":0,\"timeRangeList\":[{\"streamDvrPlanId\":0,\"weekDay\":0,\"startTime\":\"2021-05-11T01:58:37\",\"endTime\":\"2021-05-11T02:58:37\"}]}"
  • 返回参数:
true/false

OnOrOffRecordPlanByName 启用或停用一个录制计划(通过Name)

  • 作用:启用或停用一个录制计划，条件是录制计划的名称
  • 方法:HttpGet
  • 是否鉴权:是
  • 输入参数:
  • name 计划的名称
  • 调用实例:
curl -X GET "http://192.168.2.27:5800/RecordPlan/OnOrOffRecordPlanByName?name=test&enable=false" -H  "accept: text/plain"
  • 返回参数:
true/false

GetRecordPlanList 获取录制计划列表

  • 作用:获取录制计划列表
  • 方法:HttpGet
  • 是否鉴权:是
  • 输入参数:可空
  • name 指定要查询计划的名称
  • 调用实例:
curl -X GET "http://192.168.2.27:5800/RecordPlan/GetRecordPlanList" -H  "accept: text/plain"
  • 返回参数:
[//这是一个列表
  {
    "name": "test",//录制计划名称
    "enable": false,//是否启用
    "describe": "string",//描述
    "limitSpace": 0,//限制空间占用(byte)
    "limitDays": 0,//限制天数
    "overStepPlan": 0,//超过限制后的处置方式
    "timeRangeList": [//时间周期（以周为单位）,这是一个列表
      {
        "id": 90,
        "recordPlanId": 18,//计划id关联
        "weekDay": 0,//周n
        "startTime": "2021-05-11 01:58:37",//开始时间（与日期无关）
        "endTime": "2021-05-11 02:58:37"//结束时间（与日期无关）
      }
    ]
  }
]
Clone this wiki locally