接口功能介绍
本接口用于停止镜头的聚焦或光圈调节。
接口约束
- 需要支持云台的gb28181设备或ehome设备,保持设备在线。
2. 请求参数FocusStopped和IrisStopped至少填写一个。
请求参数说明:
String类型的参数,传""等同于不传。
Integer类型的参数,传0等同于不传。
Boolean类型的参数,传false等同于不传。
URI
PUT /v2/devices/*/ptz/stopAdjust
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
DeviceId | 是 | String | 设备ID。 | 752657499261403136 |
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
FocusStopped | 否 | Integer | 是否停止调整聚焦,默认0。取值:1(停止聚焦远),-1(停止聚焦近)。两种操作至少选择一种。 | 1 | |
IrisStopped | 否 | Integer | 是否停止调整光圈,默认0。取值:1(停止光圈放大),-1(停止光圈缩小)。两种操作至少选择一种。 | 1 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应状态码。 | 200 | |
error | String | 错误码,执行成功时,不返回该字段。 | VSS_0001 | |
message | String | 响应信息。 | 请求成功 | |
requestId | String | 请求ID。 | 362d4e78556b47129182d0881fade86b | |
returnObj | Object | 响应数据,执行失败时,不返回该字段。 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
DeviceId | String | 设备ID。 | 752657499261403136 | |
RequestId | String | 请求ID。 | d130fcfe74244c07a5d411bd164e8128 |
枚举参数
无
请求示例
请求url
PUT '/v2/devices/752657499261403136/ptz/stopAdjust'
请求头header
无
请求体body
{"FocusStopped": 1}
响应示例
{"statusCode": 200,"message": "请求成功","requestId": "d130fcfe74244c07a5d411bd164e8128","returnObj": {"DeviceId": "752657499261403136","RequestId": "d130fcfe74244c07a5d411bd164e8128"}}
状态码
请参考 状态码
错误码
请参考 错误码