1. 轮询组操作

轮询组操作

1.1. 添加轮询组

基础信息

路径: /v1/api/pollGroup/add

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
groupName string 是 轮询组名称,长度1-40
pointUuidList array 是 点位UUID列表
  |─ string

Body示例:

{
  "groupName": "",
  "pointUuidList": [
    ""
  ]
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─uuid string 否
  |─groupName string 是 轮询组名称
  |─pointUuidList array 否 点位UUID列表
    |─ string

响应示例:

{
  "code": 0,
  "msg": "",
  "data": {
    "uuid": "",
    "groupName": "",
    "pointUuidList": [
      ""
    ]
  }
}

1.2. 删除轮询组

基础信息

路径: /v1/api/pollGroup/delete

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
uuid string 是 UUID

Body示例:

{
  "uuid": "",
  "resourcesType": 0
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code": 0,
  "msg": "",
  "data": null
}

1.3. 轮询组列表

基础信息

路径: /v1/api/pollGroup/list

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
uuid string 否 轮询组uuid
groupName string 否 轮询组名称

Body示例:

{
  "uuid": "",
  "groupName": ""
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data array 否 具体的返回值
  |─ object
    |─uuid string 否 轮询组uuid
    |─groupName string 否 轮询组名称

响应示例:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "uuid": "",
      "groupName": ""
    }
  ]
}

1.4. 轮询组详情

基础信息

路径: /v1/api/pollGroup/detail

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
uuid string 是 UUID
needRtsp boolean 是 false 是否开流，默认不开

Body示例:

{
  "uuid": "",
  "needRtsp": "false"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─groupUuid string 否 轮询组uuid
  |─groupName string 否 轮询组名称
  |─pointList array 否 点位列表
    |─ object
      |─uuid string 否 点位uuid
      |─name string 否 点位名称
      |─rtspUrl string 否 视频流地址

响应示例:

{
  "code": 0,
  "msg": "",
  "data": {
    "groupUuid": "",
    "groupName": "",
    "pointList": [
      {
        "uuid": "",
        "name": "",
        "rtspUrl": ""
      }
    ]
  }
}

1.5. 轮询组是否存在布控

基础信息

路径: /v1/api/pollGroup/exitDeploy

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
uuid string 是 UUID

Body示例:

{
  "uuid": "",
  "resourcesType": 0
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data boolean 否 具体的返回值

响应示例:

{
  "code": 0,
  "msg": "",
  "data": false
}

1.6. 更新轮询组

基础信息

路径: /v1/api/pollGroup/update

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
uuid string 是 轮询组uuid
groupName string 否 轮询组名称
pointUuidList array 否 点位列表
  |─ string

Body示例:

{
  "uuid": "",
  "groupName": "",
  "pointUuidList": [
    ""
  ]
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code": 0,
  "msg": "",
  "data": null
}

results matching ""

    No results matching ""