获取预置位信息V3--慢直播-火山引擎

文档中心

立即注册

导航

获取预置位信息V3

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

获取设备预置位信息。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`QueryPresetInfo`	接口名称。当前 API 的名称为 `QueryPresetInfo`。
Version	String	是	`2023-10-01`	接口版本。当前 API 的版本为 `2023-10-01`。
StreamID	String	是	`23355851-2d31-461c-9e44-968a0afb72f2`	视频流 ID，可通过调用 GetDevice 接口获取

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Num	Integer	`1`	查询到的记录数量
Items	Array of Items	`-`	查询到的预置位信息列表，参考以下预置位信息结构说明

Items

参数	类型	示例值	描述
PresetID	String	`1`
PresetName	String	`预置位1`

请求示例

POST https://open.volcengineapi.com?Action=QueryPresetInfo&Version=2023-10-01&StreamID=23355851-2d31-461c-9e44-968a0afb72f2

返回示例

{
  "Result": {
    "Items": "-",
    "Num": 1
  },
  "ResponseMetadata": {
    "Service": "aiotvideo",
    "RequestId": "202306041104200100100232280022D31",
    "Action": "QueryPresetInfo",
    "Version": "2023-10-01",
    "Region": "cn-beijing"
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。