编辑上级平台--慢直播-火山引擎

文档中心

立即注册

导航

编辑上级平台

最近更新时间：2022.10.31 15:45:33首次发布时间：2022.10.31 15:45:33

更新指定上级平台的信息。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	UpdateCascadePlatform
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
PlatformID	Query	String	是	上级平台 ID	可通过调用 ListCascadePlatform 接口获取

Body 参数

字段	类型	必填	说明
PlatformName	String	是	上级平台名称
Description	String	否	上级平台描述
SipConfig	Objects	是	SIP 配置信息，参考以下 SIP 配置信息结构说明
EnableAccess	Boolean	否	是否开启平台授权
EnablePTZ	Boolean	否	是否开启 PTZ 控制权限

SIP 配置信息结构说明

字段	类型	必填	说明
SipServerID	String	是	SIP 服务器 ID
Realm	String	是	SIP 服务器域
SipServerHost	String	是	SIP 服务器 IP 地址
SipServerPort	Integer	是	SIP 服务器端口
SipUserID	String	是	SIP 用户 ID
Password	String	是	SIP密码
RegisterExpires	Integer	是	平台注册间隔时间（单位：秒），取值范围 [100-100000]
KeepAlivePeriod	Integer	是	平台心跳间隔时间（单位：秒），取值范围 [5-300]

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
ID	String	更新成功的上级平台 ID

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221017154216010225082199072270C8",
        "Action": "UpdateCascadePlatform",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "00035"
    }
}