查询组列表
最近更新时间：2025-02-21 02:50:54
1. 接口描述
接口请求域名: vssapi.ctyun.cn
默认接口请求频率限制：500次/秒。
查询组列表。
2. 请求参数
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeVSSGroups | 操作接口名，系统规定参数。 |
| GroupId | String | 否 | 1001 | 根据组ID查询。 |
| GroupName | String | 否 | 视频监控 | 根据组名称查询。 |
| Region | String | 否 | 0200001 | 根据区域查询。 |
| InProtocol | String | 否 | gb28181 | 根据组接入协议查询。 |
| GroupStatus | String | 否 | on | 根据组状态查询。 取值：on(已启用), off(已停用)。 |
| SortBy | String | 否 | CreatedTime | 选择按一个字段排序，可选值为： - GroupName - CreatedTime - UpdatedTime 默认为CreatedTime，按照创建时间排序。 |
| SortDirection | String | 否 | asc | 排序方式，默认升序。 取值：asc(升序), desc(降序)。 |
| PageNum | Long | 否 | 1 | 第几个分页，默认为1。 |
| PageSize | Long | 否 | 20 | 分页大小，默认为20。 取值范围为1～1000 |
| IncludeGroupStats | Long | 否 | 1 | 返回组设备统计信息，默认1 |
3. 返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| PageNum | Long | 第几个分页。 |
| PageSize | Long | 分页大小。 |
| TotalPage | Long | 分页总数。 |
| TotalNum | Long | 组总数。 |
| Groups | Group[] | 组列表。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
| actions | StrIng[] | 操作集合。 |
Group
| 参数 | 类型 | 描述 |
|---|---|---|
| GroupId | String | 组ID。 |
| GroupName | String | 组名称。 |
| Description | String | 组描述。 |
| AppName | String | 组使用的应用名称，默认vss。 |
| Region | String | 组所属区域。 |
| InProtocol | String | 组使用的接入协议。 取值: gb28181, rtmp, onvif, rtsp,vgroup |
| OutProtocol | String | 组使用的播放协议，多值用逗号分隔。 取值: rtmp, hls, flv, webrtc |
| SipTransProtocol | String | 组使用的sip传输协议。 仅gb28181组支持该字段。 取值：tcp, udp |
| StreamTransProtocol | String | 组使用的流媒体传输协议。 仅gb28181组支持该字段。 取值：tcp, udp |
| PullType | Long | 是否启用自动拉流，默认1。 仅gb28181组支持该字段。 取值：1, 2 取值为1，自动拉流，国标设备注册成功后自动启动拉流； 取值为2，按需拉流，需要通过触发的方式启动拉流。 |
| PushType | Long | 是否启用自动激活推流地址，默认1。 可选项，仅rtmp, rtsp组支持该字段，非rtmp, rtsp组忽略该字段。 取值：1, 2 取值为1，自动激活推流地址，设备创建完成后，平台立刻自动生成推流地址； 取值为2，按需推流，需要通过触发的方式生成推流地址。 |
| GroupEnabled | Long | 组是否启用。 取值：0(停用), 1(启用) |
| GroupStatus | String | 组状态。 取值：on(已启用), off(已停用)。 |
| SipId | String | 组提供的国标SIP服务器ID。 |
| SipIp | String | 组提供的国标SIP服务器地址。 |
| SipTcpPort | Long | 组提供的国标SIP服务器TCP端口，如5060。 |
| SipUdpPort | Long | 组提供的国标SIP服务器UDP端口，如6060。 |
| GroupStats | String | 组设备统计信息。 |
| CreatedTime | String | 组创建时间。 |
| UpdatedTime | String | 组更新时间。 |
| RegionName | String | 区域名称。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
| InNetworkType | String | 组使用的接入网络类型，默认public。 取值：public, private 取值为public, 设备使用互联网接入； 取值为private, 设备使用专线网络接入。 |
| OutNetworkType | String | 组使用的播放网络类型，默认public。 取值：public, private 取值为public, 客户使用互联网观看直播和点播； 取值为private, 客户使用专线网络观看直播和点播。 |
GroupStats
| 参数 | 类型 | 描述 |
|---|---|---|
| DeviceSize | Long | 组内设备总数。 |
| IpcSize | Long | 组内摄像头数量。 |
| NvrSize | String | 组内nvr设备数量：通道设备数量。 |
| PlatformSize | String | 组内平台设备数量：通道设备数量。 |
4. 示例
4.1 请求示例
https://vssapi.ctyun.cn/
?Action=DescribeVSSGroups
&IncludeGroupStats=1
&Version=2020-06-12
&AccessKeyId=O0G0BPBI2T9YUD3U****
&Signature=THG6eLrZcwMbd1bs7H0eErYYzSY%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=674296767
&SignatureVersion=1.0
&Timestamp=1599026762
4.2 返回示例
{
"PageNum": 1,
"PageSize": 20,
"TotalPage": 3,
"TotalNum": 46,
"Groups": [
{
"GroupId": "745958207091900416",
"GroupName": "2020082001",
"Description": "",
"AppName": "vss",
"Region": "华东",
"InProtocol": "gb28181",
"OutProtocol": "rtmp",
"SipTransProtocol": "",
"StreamTransProtocol": "",
"PullType": 1,
"PushType": 0,
"GroupEnabled": 1,
"GroupStatus": "on",
"SipId": "31011500012008296726",
"SipIp": "127.0.0.1",
"SipTcpPort": 5070,
"SipUdpPort": 5070,
"GroupStats": {
"DeviceSize": 14,
"IpcSize": 5,
"NvrSize": "5:4",
"PlatformSize": "0:0"
},
"CreatedTime": "2020-08-20 10:51:36",
"UpdatedTime": "2020-08-20 10:51:36"
},
{
"GroupId": "746334271509102592",
"GroupName": "2020082101",
"Description": "",
"AppName": "vss",
"region": "华东",
"InProtocol": "gb28181",
"OutProtocol": "rtmp",
"SipTransProtocol": "",
"StreamTransProtocol": "",
"PullType": 2,
"GroupEnabled": 0,
"GroupStatus": "on",
"SipId": "31011500012008296726",
"SipIp": "127.0.0.1",
"SipTcpPort": 5070,
"SipUdpPort": 5070,
"GroupStats": {
"DeviceSize": 5,
"IpcSize": 3,
"NvrSize": "1:1",
"PlatformSize": "0:0"
},
"CreatedTime": "2020-08-21 11:45:57",
"UpdatedTime": "2020-08-26 16:29:53"
}
],
"RequestId": "69934d842b7a45ca8dee24dd42547ea4",
"InNetworkType": "",
"OutNetworkType": ""
}
5. 错误码
| ErrorCode | ErrorMessage |
|---|---|
本页目录：