You need to enable JavaScript to run this app.
导航
慢直播
  • 文档首页
    • /
  • 慢直播

创建上级平台

最近更新时间：2022.10.31 15:45:33

首次发布时间：2022.10.31 15:45:33

我的收藏

创建上级平台。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考「公共参数」。

字段
位置
类型
必填
说明
值
ActionQueryString是公共参数，OpenAPI 接口名称CreateCascadePlatform
VersionQueryString是公共参数，OpenAPI 接口版本2021-01-01

Body 参数

字段
类型
必填
说明
PlatformNameString是上级平台名称
DescriptionString否上级平台描述
SipConfigObjects是SIP 配置信息，参考以下 SIP 配置信息结构说明
EnableAccessBoolean是是否开启平台授权
EnablePTZBoolean是是否开启 PTZ 控制权限

SIP 配置信息结构说明

字段
类型
必填
说明
SipServerIDString是SIP 服务器 ID
RealmString是SIP 服务器域
SipServerHostString是SIP 服务器 IP 地址
SipServerPortInteger是SIP 服务器端口
SipUserIDString是SIP 用户 ID
PasswordString是SIP密码
RegisterExpiresInteger是平台注册间隔时间（单位：秒），取值范围 [100-100000]
KeepAlivePeriodInteger是平台心跳间隔时间（单位：秒），取值范围 [5-300]

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构体说明。

Result 字段包含以下参数：

字段
类型
说明
IDString创建成功的上级平台 ID

示例

请求示例

POST https://open.volcengineapi.com?Action=CreateCascadePlatform
&Version=2021-01-01
&<公共请求参数>
{
  "PlatformName": "API创建",
  "Description": "通过API创建国标级联平台",
  "SipConfig": {
    "SipServerID": "3402000000xxxxxxxxx",
    "Realm": "1000xxxxxx",
    "SipServerHost": "10.xxx.xxx.xxx",
    "SipServerPort": 5060,
    "SipUserID": "340200129920xxxxxxxx",
    "Password": "xxxxxxxx",
    "RegisterExpires": 3600,
    "KeepAlivePeriod": 60
  },
  "EnableAccess": true,
  "EnablePTZ": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022101715224201022514606302D25A51",
        "Action": "CreateCascadePlatform",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "00035"
    }
}