添加国标下级平台
接口调用说明
请求地址 : /v1/api/platform/add
请求方式 : POST
请求头
参数名 | 参数值 | 是否必须 |
---|---|---|
Content-Type | application/json | 是 |
X-Token | 实际 accessToken | 是 |
请求报文体
名称 | 类型 | 是否必须 | 备注 |
---|---|---|---|
platformId | string | 是 | 下级平台 id |
enableAuth | boolean | 是 | 是否对下级平台鉴权 |
sipAuthPassword | string | 否 | 下级级联平台校验密码,enableAuth=true 时必填 |
platformIp | string | 否 | 下级平台安装地址(即下级级联平台内网地址) |
platformPort | number | 否 | 下级级联平台的端口号 |
platformType | string | 是 | 级联平台类型(厂商) 取值: uniview-宇视 hikvision-海康 dahua-大华 huawei-华为 other-其他 |
streamTransportMode | string | 是 | 流传输模式 UDP-UDP 方式 TCP_PASSIVE-TCP 被动 |
platformOwnerIp | string | 否 | 所属服务 IP 地址 (多网域场景下级平台 使用本地的某个网域 的 IP 地址) |
//示例数据
{
"platformId": "37010200002000000001",
"sipAuthPassword": "Aa123456",
"platformIp": "192.168.1.123",
"platformPort": "8111",
"enableAuth": true,
"platformType": "hikvision",
"streamTransportMode": "UDP",
"platformOwnerIp": "192.168.10.123"
}
响应报文
名称 | 类型 | 是否必须 | 备注 |
---|---|---|---|
code | int | 是 | 状态码 |
msg | String | 是 | 状态码解释信息 |
data | Object | 是 | 返回内容(详情见下表) |
data 内容如下:
名称 | 类型 | 是否必须 | 备注 |
---|---|---|---|
sipServerId | string | 是 | 上级级联国标平台服务编码 ID |
sipServerDomain | string | 是 | 上级级联国标平台服务域 |
sipServerIp | string | 是 | 上级级联国标平台服务 IP 地 |
sipServerPort | int | 是 | 上级级联国标平台服务 port 端口 |
sipServerAddr | String | 是 | 上级级联国标平台服务接入地址 |
//示例数据
{
"code": 1000,
"msg": "OK",
"data": {
"sipServerId": "12345",
"sipServerDomain": "111",
"sipServerIp": "192.168.12.12",
"sipServerPort": 1234,
"sipServerAddr": "example.com"
}
}
错误码
状态码 | 状态描述 |
---|---|
1000 | 成功 |
1001 | 参数错误 |
1002 | 请求异常 |
1006 | AccessToken 异常或过期 |
2018 | 平台 ID 已存在 |