1. 接口描述

接口请求域名: vssapi.ctyun.cn
默认接口请求频率限制：500次/秒。

创建RTMP设备。

2. 请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateDevice	操作接口名，系统规定参数。
GroupId	String	是	32388483999	设备所属组ID。
InProtocol	String	是	rtmp	使用的接入协议。取值: rtmp
InType	String	是	push	视频流接入方式。取值: push, pull 取值为push，推流；取值为pull，拉流。
DirId	String	否	600001	目录ID。
DeviceType	String	是	ipc	设备类型。取值: ipc
DeviceVendor	String	否	haikang	设备厂商。
DeviceName	String	是	xx	设备名称。
Description	String	否	xx	设备描述。
PullType	Long	否	1	是否启用自动拉流, InType设置为pull，该字段才有效。默认继承组PullType，但如果设置了该字段，则会覆盖组下面的PullType值。取值：1, 2。默认为1。取值为1，自动拉流，设备创建成功后，平台自动启动拉流；取值为2，按需拉流，需要通过触发的方式启动拉流。
PushType	Long	否	1	是否启用自动激活推流地址，InType设置为push，该字段才有效。默认继承组PushType，但如果设置了该字段，则会覆盖组下面的PushType值。取值：1, 2。默认为1。取值为1，自动激活推流地址，设备创建完成后，平台立刻自动生成推流地址；取值为2，按需推流，需要通过触发的方式生成推流地址。
PullUrl	String	否	rtmp://192.168.0.1:1935/live/101	拉流地址。如果InType设置为pull, 该字段为必选
Tags	String	否	key1:value1,key2:value2	和视频流关联的标签。一个视频流最多添加10个标签。
GbRegion	String	否	51030300	设备区域编码，编码长度为8位。字段值为空时，默认继承业务组所属区域取值按照用户或设备所归属的监控中心所在地的行政区划代码确定。
GbRegionLevel	Long	否	3	设备区域级别，编码长度为1位
IndustryCode	String	是	04	设备行业编码，编码长度为2位。 IndustryCode值为空时默认继承业务组所属行业。行业编码是指用户或设备所归属的行业
NetworkCode	String	否	7	业务组网络标识。取值如下： 0、1、2、3、4 为监控报警专网，5 为公安信息网，6 为政务网，7 为 Internet 网，8 为社会资源接入网，9 预留
OrderResource	String	否	[{"ResourceId":"resource10","ResourceType":"VSS_VIDEO","WorkOrderId":"work_order_10"}]	资源包集合
OrderAIApp	String	否	[{"Id": "72", "AnalyseType": "AI-200"}, {"Id": "278", "AnalyseType": "AI-100"}]	AI应用集合

OrderResource

参数	类型	是否必选	示例值	描述
WorkOrderId	String	是	work_order_10	订单ID
ResourceId	String	是	resource10	资源ID
ResourceType	String	是	VSS_VIDEO 视频包 VSS_AI ai包 VSS_UPLOAD_BW上行带宽包	资源类型

OrderAIApp

参数	类型	是否必选	示例值	描述
Id	String	是	72	ai应用ID
AnalyseType	String	是	AI-200	ai应用类型

3. 返回参数

参数	类型	描述
DeviceId	String	设备ID。
CreatedTime	String	设备创建时间。
UpdatedTime	String	设备更新时间。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

4.1 请求示例

https://vssapi.ctyun.cn/
?Action=CreateDevice
&OrderResource=[{"ResourceId":"resource10","ResourceType":"VSS_VIDEO","WorkOrderId":"work_order_10"}]
&OrderAIApp=[{"Id": "72", "AnalyseType": "AI-200"}, {"Id": "278", "AnalyseType": "AI-100"}]
&GroupId=742711514552598528
&InProtocol=rtmp
&InType=push
&DirId=600001
&DeviceType=ipc
&DeviceVendor=haikang
&DeviceName=haikang
&Description=test-platform
&PullType=1
&PushType=1
&PullUrl=rtmp://192.168.0.1:1935/live/101
&Tags=key1:value1,key2:value2
&Version=2020-06-12
&AccessKeyId=O0G0BPBI2T9YUD3U****
&Signature=%2FUKPWN9c6i1aUftJGt1OgUTqjck%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=1262606746
&SignatureVersion=1.0
&Timestamp=1599108325

4.2 返回示例

{
    "GroupId": "282007604284276739",
    "GbId": "",
    "DeviceId": "282256196991369216",
    "CreatedTime": "2021-09-16 18:16:01",
    "UpdatedTime": "2021-09-16 18:16:01",
    "DeviceChannels":[],
    "RequestId": "13fc2cf643304761bc10730210dc097e",
    "EhomeId": ""
}

5. 错误码

ErrorCode	ErrorMessage

创建设备

最近更新时间：2025-02-21 02:50:53

1. 接口描述

2. 请求参数

OrderResource

OrderAIApp

3. 返回参数

4. 示例

4.1 请求示例

4.2 返回示例

5. 错误码