查询上级平台列表--慢直播-火山引擎

文档中心

立即注册

导航

查询上级平台列表

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

查询已创建的上级平台的信息。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ListCascadePlatform
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
PlatformName	Query	String	否	上级平台名称，如不指定，则查询所有已创建的上级平台	支持模糊搜索
Order	Query	Integer	否	查询结果排序方式	可选枚举值： 1（正序） -1（倒序，默认）

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
CascadePlatforms	Array of objects	查询到的上级平台列表，参考以下 `List<CascadePlatforms>` 数据结构说明

List<CascadePlatforms> 数据结构说明

字段	类型	说明
PlatformID	String	上级平台 ID
PlatformName	String	上级平台名称
Description	String	上级平台描述
SipConfig	Objects	SIP 配置信息，参考以下 SIP 配置信息结构说明
EnableAccess	Boolean	是否开启平台授权
EnablePTZ	Boolean	是否开启 PTZ 控制权限
Status	String	状态
CreateAt	String	创建时间
UpdateAt	String	更新时间

SIP 配置信息结构说明

字段	类型	说明
SipServerID	String	SIP 服务器 ID
Realm	String	SIP 服务器域
SipServerHost	String	SIP 服务器 IP 地址
SipServerPort	Integer	SIP 服务器端口
SipUserID	String	SIP 用户 ID
Password	String	SIP密码
RegisterExpires	Integer	平台注册间隔时间（单位：秒）
KeepAlivePeriod	Integer	平台心跳间隔时间（单位：秒）

示例

请求示例

GET https://open.volcengineapi.com?Action=ListCascadePlatform
&Version=2021-01-01
&PlatformName=vo
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221017120429010225082199069C3437",
        "Action": "ListCascadePlatform",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "CascadePlatforms": [
            {
                "PlatformID": "00034",
                "PlatformName": "vop",
                "Description": "",
                "SipConfig": {
                    "SipServerID": "3402000000xxxxxxxxxx",
                    "Realm": "34xxxxxxxx",
                    "SipServerHost": "10.xxx.xxx.xxx",
                    "SipServerPort": 8333,
                    "SipUserID": "3402009599xxxxxxxxxx",
                    "Password": "AAxxxxxxxx",
                    "RegisterExpires": 3600,
                    "KeepalivePeriod": 60
                },
                "EnableAccess": true,
                "EnablePTZ": true,
                "Status": "registered",
                "CreateAt": "2022-09-14T18:09:31+08:00",
                "UpdateAt": "2022-10-17T09:52:14+08:00"
            }
        ]
    }
}