天翼云智能视图服务API

1.开启镜头调节

接口功能介绍

本接口用于调节镜头聚焦或光圈。

接口约束

支持gb28181设备和ehome设备。请求参数Focus和Iris至少填写一个，且不能同时填写。

URI

PUT /devices/{DeviceId}/ptz/startAdjust

路径参数

参数	是否必填	参数类型	说明	示例	下级对象
DeviceId	是	String	设备ID。	752657499261403136

Query参数
无

请求参数

请求头header参数

参数	是否必填	参数类型	说明	示例
Authorization	是	String	认证信息。	CT-HMAC-SHA256 Credential=FQ01GA2RR9IJFM1PWIPR/2023-07-18/vss, SignedHeaders=content-type;host;timestamp, Signature=c6e72dffcfb2d25d276e119781e1deb6656d966702191b2bd862d1691e39394f
Content-Type	是	String	互联网媒体类型。	application/json;charset=utf-8
Host	是	String	主机。	vssapi.ctyun.cn
Version	是	String	版本。	2021-11-25
Timestamp	是	String	时间戳。	1689643309

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
Focus	否	Integer	聚焦速度参数，正值表示焦距变远。取值: -255~255。	255
Iris	否	Integer	光圈速度参数，正值表示光圈放大。取值: -255~255。	255

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	响应状态码。	200
error	String	错误码，执行成功时，不返回该字段。	VSS_0001
message	String	响应信息。	请求成功
requestId	String	请求ID。	362d4e78556b47129182d0881fade86b
returnObj	Object	响应数据，执行失败时，不返回该字段。		returnObj

表 returnObj

参数	参数类型	说明	示例	下级对象
DeviceId	String	设备ID。	752657499261403136
RequestId	String	请求ID。	20be6a0c4b0f42a288fb563c561d0a4c

请求示例

请求url

PUT '/devices/752657499261403136/ptz/startAdjust'

请求头header

{
    "Authorization": "CT-HMAC-SHA256 Credential=SBGX5QWGRAC5QMDQUXIZ/2023-06-15/vss, SignedHeaders=content-type;host;timestamp, Signature=581a85517ab9a684c5250d97a3a587e272ad4fc9ab9c1197a57f78b97e2d7a53",
    "Content-Type": "application/json;charset=utf-8",
    "Host": "vssapi.ctyun.cn",
    "Version": "2021-11-25",
    "Timestamp": "1689643309"
}

请求体body

{
  "Focus": 255
}

响应示例

{
  "statusCode": 200,
  "message": "请求成功",
  "requestId": "20be6a0c4b0f42a288fb563c561d0a4c",
  "returnObj": {
    "DeviceId": "752657499261403136",
    "RequestId": "20be6a0c4b0f42a288fb563c561d0a4c"
  }
}

状态码

请参考状态码说明。

错误码

请参考错误码说明。

开启镜头调节

最近更新时间：2026-03-19 18:16:28