功能介绍
默认接口请求频率限制：500次/秒。
查询组信息。
接口约束
查询组前确保组存在。
URI
GET /v1?
请求参数
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeVSSGroup | 操作接口名，系统规定参数。 |
| GroupId | String | 是 | 208383238668288 | 组ID。 |
| IncludeGroupStats | Long | 否 | 1 | 是否返回组设备统计信息，默认0取值：0(不返回), 1(返回) |
返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| GroupId | String | 组ID。 |
| GroupName | String | 组名称。 |
| Description | String | 组描述。 |
| AppName | String | 组使用的应用名称，默认vss。 |
| Region | String | 组所属区域。 |
| InProtocol | String | 组使用的接入协议。 |
| OutProtocol | String | 组使用的播放协议，多值用逗号分隔。 |
| SipTransProtocol | String | 组使用的sip传输协议。仅gb28181组支持该字段。取值：tcp, udp |
| StreamTransProtocol | String | 组使用的流媒体传输协议。仅gb28181组支持该字段。取值：tcp, udp |
| PullType | Long | 是否启用自动拉流，默认1。取值：1, 2取值为1，自动拉流，国标设备注册成功后自动启动拉流；取值为2，按需拉流，需要通过触发的方式启动拉流。 |
| PushType | Long | 是否启用自动激活推流地址，默认1。可选项，仅rtmp, rtsp组支持该字段，非rtmp, rtsp组忽略该字段。取值：1, 2取值为1，自动激活推流地址，设备创建完成后，平台立刻自动生成推流地址；取值为2，按需推流，需要通过触发的方式生成推流地址。 |
| GroupEnabled | Long | 组是否启用。取值：0(停用), 1(启用) |
| GroupStatus | String | 组状态。取值：oning(启用中), on(已启用), offing(停用中), off(已停用)。 |
| SipId | String | 组提供的国标SIP服务器ID。 |
| SipIp | String | 组提供的国标SIP服务器地址。 |
| SipTcpPort | Long | 组提供的国标SIP服务器TCP端口，如5060。 |
| SipUdpPort | Long | 组提供的国标SIP服务器UDP端口，如6060。 |
| GroupStats | GroupStats | 组设备统计信息。 |
| CreatedTime | String | 组创建时间。 |
| UpdatedTime | String | 组更新时间。 |
| RegionName | String | 区域名称。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
| InNetworkType | String | 组使用的接入网络类型，默认public。取值：public, private取值为public, 设备使用互联网接入；取值为private, 设备使用专线网络接入 |
| OutNetworkType | String | 组使用的播放网络类型，默认public。取值：public, private取值为public, 客户使用互联网观看直播和点播；取值为private, 客户使用专线网络观看直播和点播。 |
| GbId | String | 组国标ID。 |
| GbRegion | String | 业务组区域编码，编码长度为8位。取值按照用户或设备所归属的监控中心所在地的行政区划代码确定 。 |
| GbRegionLevel | Long | 业务组区域级别，编码长度为1位。 |
| IndustryCode | String | 业务组行业编码，编码长度为2位。行业编码是指用户或设备所归属的行业。 |
| NetworkCode | String | 业务组网络标识。取值如下：0、1、2、3、4 为监控报警专网，5 为公安信息网，6 为政务网，7 为 Internet 网，8为社会资源接入网，9 预留 |
GroupStats
| 参数 | 类型 | 描述 |
|---|---|---|
| DeviceSize | Long | 组内设备总数。 |
| IpcSize | Long | 组内摄像头数量。 |
| NvrSize | String | 组内nvr设备数量：通道设备数量。 |
| PlatformSize | String | 组内平台设备数量：通道设备数量。 |
示例
请求示例
GET https://vss-dsp-gzgy2-a.ctapi.ctyun.cn/v1?Action=DescribeVSSGroup&GroupId=581819136341524480
Connection: keep-alive
ctyun-eop-request-id: 571b1b6f-610c-458f-8fb9-955b1838621d
Eop-date: 20221025T092437Z
Eop-Authorization: BLLOJSUVKOZ7RVV9VEFF Headers=ctyun-eop-request-id;eop-date Signature=HmKIMyQnT1G5kTO/tjBn1yLxVIoRMHHb87ifzlg6KvA=
Host: vss-dsp-gzgy1-a.ctapi-test.ctyun.cn
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.14)
返回示例
{
"GroupId": "581819136341524480",
"GroupName": "fgbyfa",
"Description": "",
"AppName": "live",
"Region": "0851001",
"InProtocol": "gb28181",
"OutProtocol": "webrtc",
"SipTransProtocol": "tcp",
"StreamTransProtocol": "tcp",
"PullType": 1,
"PushType": 1,
"GroupEnabled": 1,
"GroupStatus": "on",
"SipId": "52010000012008581001",
"SipIp": "182.43.127.35",
"SipTcpPort": 15062,
"SipUdpPort": 15062,
"GroupStats": {
"DeviceSize": 0,
"IpcSize": 0,
"NvrSize": "",
"PlatformSize": ""
},
"CreatedTime": "2022-10-25 09:24:38",
"UpdatedTime": "2022-10-25 09:24:38",
"RegionName": "贵阳1",
"RequestId": "4bf0660e59944a4fa0d771ba56658e53",
"InNetworkType": "public",
"OutNetworkType": "public",
"GbId": "51030300042157002063",
"GbRegion": "51030300",
"GbRegionLevel": 3,
"IndustryCode": "04",
"NetworkCode": "7"
}
