CloudControl - 云台控制--慢直播-火山引擎

文档中心

立即注册

导航

CloudControl - 云台控制

最近更新时间：2025.06.16 19:21:23首次发布时间：2025.02.14 16:29:36

云台控制

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=CloudControl&Version=2023-10-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	CloudControl	要执行的操作，取值：CloudControl。
Version	String	是	2023-10-01	API的版本，取值：2023-10-01。
StreamID	String	是	23355851-2d31-461c-9e44-968a0afb72f2	设备通道流 ID，可通过调用 GetDevice 接口获取
Cmd	String	是	left	控制行为，参考以下控制行为和取值范围列表 PTZControl Cmd: stop/right/left/down/up/rightup/rightdown/leftup/leftdown/zoomin/zoomout FiControl Cmd: /stop/focusfar/focusnear/irisin/irisout PresetControl Cmd: set/goto/remove
Para	Integer	是	2	参数取值范围，参考以下控制行为和取值范围列表
Action	String	是	PTZControl	操控指令类型，可选枚举值包括： PTZControl FiControl PresetControl

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=CloudControl&Version=2023-10-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250616T105114Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250616/cn-beijing/aiotvideo/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "StreamID": "23355851-2d31-461c-9e44-968a0afb72f2",
  "Cmd": "left",
  "Para": 2,
  "Action": "PTZControl"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202506161851181151901110335E596F",
    "Action": "CloudControl",
    "Version": "2023-10-01",
    "Service": "aiotvideo",
    "Region": "cn-beijing"
  },
  "Result": {}
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
500	ErrorDeviceNotOnline	OperationDeny.DeviceNotOnline
500	ErrorDeviceSipError	InternalError.SipError