功能介绍
默认接口请求频率限制：500次/秒。
创建视频监控业务组，是用来管理设备的逻辑集合。
接口约束
- 该业务组之前未创建过，组名不可重复。
- 需要对应的接入区域region支持国标接入服务。
URI
GET /v1?
请求参数
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | CreateVSSGroup | 操作接口名，系统规定参数。 |
| GroupName | String | 是 | openapi-group | 组名称，长度 4-64位，可包含大小写字母、数字、中文、中划线、下划线、小括号、空格，不能以空格作为名称的首尾。 |
| Description | String | 否 | create+openapi+group | 组描述，长度不超过255个字符。 |
| AppName | String | 否 | live | 组使用的应用名称，默认vss。 |
| Region | String | 是 | 0851002 | 组所属区域 。取值: 0851002: 表示贵州贵阳2 0523001: 表示江苏泰州1 0523002: 表示江苏泰州2 0553001: 表示安徽芜湖1 0200001: 表示广东广州1 0591001: 表示福建福州1 0931001: 表示甘肃兰州1 0936001: 表示甘肃张掖1 默认值:0851002 |
| InProtocol | String | 是 | gb28181 | 组使用的接入协议。取值: gb28181，ehome，rtmp，rtsp，onvif。 |
| OutProtocol | String | 是 | webrtc | 组使用的播放协议，多值用逗号分隔。取值: rtmp，hls，flv，webrtc。 |
| PullType | Long | 否 | 1 | 是否启用自动拉流，默认1。取值：1, 2；取值为1，自动拉流，平台自动启动拉流；取值为2，按需拉流，需要通过触发的方式启动拉流。取值为0，等同于不传该参数。 |
| PushType | Long | 否 | 1 | 是否启用自动激活推流地址，默认1。可选项，仅rtmp, rtsp组支持该字段，非rtmp, rtsp组忽略该字段。取值：1, 2；取值为1，自动激活推流地址，设备创建完成后，平台立刻自动生成推流地址；取值为2，按需推流，需要通过触发的方式生成推流地址。取值为0，等同于不传该参数。 |
| InNetworkType | String | 否 | public | 组使用的接入网络类型，默认public。取值：public, private取值为public, 设备使用互联网接入；取值为private, 设备使用专线网络接入。 |
| OutNetworkType | String | 否 | public | 组使用的播放网络类型，默认public。取值：public, private取值为public, 客户使用互联网观看直播和点播；取值为private, 客户使用专线网络观看直播和点播。 |
| GbRegion | String | 是 | 51030300 | 业务组区域编码，编码长度为8位。取值按照用户或设备所归属的监控中心所在地的行政区划代码确定 。 |
| GbRegionLevel | Long | 否 | 3 | 业务组区域级别，编码长度为1位。 |
| IndustryCode | String | 是 | 04 | 业务组行业编码，编码长度为2位。行业编码是指用户或设备所归属的行业。 |
| NetworkCode | String | 否 | 7 | 业务组网络标识。取值如下：0、1、2、3、4 为监控报警专网，5 为公安信息网，6 为政务网，7 为 Internet 网，8为社会资源接入网，9 预留 |
返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| GroupId | String | 组ID。 |
| SipId | String | 组提供的国标SIP服务器ID。可选项，非gb28181组忽略该字段。 |
| SipIp | String | 组提供的国标SIP服务器地址。可选项，非gb28181组忽略该字段。 |
| SipTcpPort | Long | 组提供的国标SIP服务器TCP端口，如5060。可选项，非gb28181组忽略该字段。 |
| SipUdpPort | Long | 组提供的国标SIP服务器UDP端口，如6060。可选项，非gb28181组忽略该字段。 |
| CreatedTime | String | 组创建时间。 |
| UpdatedTime | String | 组更新时间。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
示例
请求示例
GET https://vss-dsp-gzgy2-a.ctapi.ctyun.cn/v1?Action=CreateVSSGroup&GbRegion=51030300&GroupName=wcsrcl&InProtocol=gb28181&IndustryCode=04&OutProtocol=webrtc&Region=0851001
Connection: keep-alive
ctyun-eop-request-id: 8fd3b13f-0908-41ef-abe8-ef5107a0fd4a
Eop-date: 20221025T091152Z
Eop-Authorization: BLLOJSUVKOZ7RVV9VEFF Headers=ctyun-eop-request-id;eop-date Signature=JCjbZpy6kpaB/MZpaOdHjYq1yzUQcHBnP6CS7vTWV7I=
Host: vss-dsp-gzgy1-a.ctapi-test.ctyun.cn
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.14)
返回示例
{
"GroupId": "581812565041561600",
"SipId": "52010000012008581001",
"SipIp": "182.43.127.35",
"SipTcpPort": 15062,
"SipUdpPort": 15062,
"CreatedTime": "2022-10-25 09:11:52",
"UpdatedTime": "2022-10-25 09:11:52",
"RequestId": "8a9f822b2a2e4867bd43616ab1cc34ea"
}
