创建上级视图--慢直播-火山引擎

文档中心

立即注册

导航

慢直播

创建上级视图

最近更新时间：2022.11.01 17:47:38首次发布时间：2022.11.01 17:47:38

创建上级视图。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	CreateStructuredViewCascadePlatform
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01

Body 参数

字段	类型	必填	说明
PlatformName	String	是	上级视图名称
PlatformCode	String	是	上级视图接入编码
PlatformIP	String	是	上级视图 IP
PlatformPort	Int	是	端口号
Description	String	否	描述

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
ID	String	创建成功的上级视图 ID

示例

请求示例

POST https://open.volcengineapi.com?Action=CreateStructuredViewCascadePlatform
&Version=2021-01-01
&<公共请求参数>
{
  "PlatformName": "OpenAPI创建", 
  "PlatformCode": "18032802085031xxxxxx",
  "PlatformIP": "123.xxx.xxx.xxx", 
  "PlatformPort": 20020,
  "Description": "通过OpenAPI创建"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022102415521601022508219905E00FAA",
        "Action": "CreateStructuredViewCascadePlatform",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "cp_5ik4yiyzl4xxxxxx"
    }
}