You need to enable JavaScript to run this app.
导航
添加视图设备
最近更新时间:2022.11.01 17:47:37首次发布时间:2022.11.01 17:47:37

添加视图设备。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段
类型
必填
说明
ViewNameString视图接入名称

ViewType

String

视图接入类型,可选项:

  • 采集设备

  • 采集系统

  • 视图库

  • 应用平台

  • 分析设备

ViewCodeString视图接入编码
ViewSpaceIDString视图空间 ID
ViewSpaceNameString视图空间名称
ViewIPString视图视图库 IP
ViewPortInt接入端口号
ProtocolString接入协议(GA1400)
UsernameString视图库用户名
PasswordString密码
DescriptionString描述
LocationString设备经纬度(经度,纬度)
AdministrativeIDString安装地点行政区划代码

返回结果

返回参数说明

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

Result 字段包含以下参数:

字段
类型
说明
IDString添加成功的视图设备 ID

示例

请求示例

POST https://open.volcengineapi.com?Action=CreateStructuredView
&Version=2021-01-01
&<公共请求参数>
{
    "ViewName": "API创建",
    "ViewType": "采集设备",
    "ViewCode": "62984415861199xxxxxx",
    "ViewSpaceName": "API创建",
    "ViewIP": "123.xxx.xxx.xxx",
    "ViewPort": 20020,
    "Protocol": "GA1400",
    "Username": "test",
    "Password": "test",
    "Description": "API创建视图设备",
    "Location": "116,39",
    "AdministrativeID": "123123"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221024100028010225146063079D256B",
        "Action": "CreateStructuredView",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "v_kujqa6q7v2xxxxxx"
    }
}