查询预置位列表
最近更新时间：2026-03-19 18:16:28
天翼云智能视图服务API
1.查询预置位列表
接口功能介绍
本接口用于查询预置位列表。
接口约束
仅支持gb28181设备。
URI
GET /devices/{DeviceId}/ptz/presets
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| 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参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应状态码。 | 200 | |
| error | String | 错误码，执行成功时，不返回该字段。 | VSS_0001 | |
| message | String | 响应信息。 | 请求成功 | |
| requestId | String | 请求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 响应数据，执行失败时，不返回该字段。 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| DeviceId | String | 设备ID。 | 752657499261403136 | |
| DevicePresets | Array of Objects | 预置位列表。 | DevicePreset | |
| RequestId | String | 请求ID。 | 03f07edc8d414fb1ba561c0831226289 |
表 DevicePreset
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| PresetId | String | 预置位编码。 | 1 | |
| PresetName | String | 预置位名称。 | 预置位1 |
请求示例
请求url
GET '/devices/752657499261403136/ptz/presets'
请求头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
无
响应示例
{
"statusCode": 200,
"message": "请求成功",
"requestId": "03f07edc8d414fb1ba561c0831226289",
"returnObj": {
"DeviceId": "752657499261403136",
"DevicePresets": [
{
"PresetId": "1",
"PresetName": "预置位1"
},
{
"PresetId": "2",
"PresetName": "预置位2"
}
],
"RequestId": "03f07edc8d414fb1ba561c0831226289"
}
}
状态码
请参考状态码说明。
错误码
请参考错误码说明。
本页目录：