CreateRtmpDevice_物联网智能视频服务(LinkVisual)-阿里云帮助中心

QPS限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。

说明单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	CreateRtmpDevice	系统规定参数。取值：CreateRtmpDevice。
IotInstanceId	String	是	iot-cn-n6w1y59****	实例ID。您可在物联网平台控制台的实例概览页签，查看当前实例的ID。
ProductKey	String	是	a1BwAGV****	设备所属产品的ProductKey。您可以在物联网平台控制台产品页查看或调用QueryProductList查看当前账号下所有产品的信息。
PullKeyExpireTime	Integer	否	3600	播流URL有效期，默认值3600，单位秒。时长范围为60秒~7200秒。
Description	String	否	test	设备描述信息，长度限制为1~350个字符。
DeviceName	String	否	device01	设备名称。设备名称在产品内具有唯一性。支持英文字母、数字、短划线（-）、下划线（_）、at（@）、英文句号（.）和英文冒号（:），长度限制为4~32个字符。说明 DeviceName可以为空。为空时，由物联网平台随机生成一个产品内唯一标识符作为设备的DeviceName。
PushKeyExpireTime	Integer	否	3600	收流URL有效期，默认值3600，单位秒。时长范围为60秒~7200秒。
PushAuthKey	String	否	PH******fpn	收流鉴权Key，支持英文字母和数字，长度限制为8~16位。
PullAuthKey	String	否	z8X5*****OQ	播流鉴权Key，支持英文字母和数字，长度限制为8~16位。
SubStreamName	String	否	subtest	RTMP流的子流名称。如果不传入该参数，则由系统随机生成。支持英文字母、数字、中划线（-），长度限制为4~32个字符。

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

返回数据

名称	类型	示例值	描述
Code	String	400	接口返回码： 200：表示成功。其它：表示错误码。错误码详情，请参见错误码。
Data	Struct		返回的设备信息。
DeviceName	String	device01	设备名称。
IotId	String	y4u2weAIrpp****WHMle1234	设备ID。
StreamName	String	linkvisual_iot-*******i_test	RTMP流名称。
ErrorMessage	String	Request error.	调用失败时，返回的出错信息。
RequestId	String	E55*B7-4-4-8-D3*****F565	阿里云为该请求生成的唯一标识符。
Success	Boolean	true	是否调用成功： true：调用成功。 false：调用失败。

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=CreateRtmpDevice
&IotInstanceId=iot-cn-n6w1y59****
&ProductKey=a1BwAGV****
&DeviceName=device01
&PushAuthKey=PH******fpn
&PullAuthKey=z8X5*****OQ
&<公共请求参数>

正常返回示例

XML格式

<CreateRtmpDeviceResponse>
  <RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>
  <Data>
        <IotId>y4u2weAIrpp****WHMle1234</IotId>
        <StreamName>linkvisual_iot-*******i_test</StreamName>
        <DeviceName>device01</DeviceName>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</CreateRtmpDeviceResponse>

JSON格式

{
    "RequestId": "E55***B7-4***-4***-8***-D3******F565",
    "Data": {
        "IotId": "y4u2weAIrpp****WHMle1234",
        "StreamName": "linkvisual_iot-*******i_test",
        "DeviceName": "device01"
    },
    "Code": 200,
    "Success": true
}

错误码

HttpCode	错误码	错误信息	描述
403	iot.vision.RequestForbidden	Request forbidden.	请求被禁止。
429	iot.vision.RequestTrafficControl	Request traffic control.	请求太频繁被限流。
400	iot.vision.RequestParameterError	Request parameter error:%s	请求参数错误。
400	iot.vision.DeviceNameDuplicate	Device name duplicate.	设备名已存在。
400	iot.vision.StreamNameDuplicate	Stream name duplicate.	流名称重复。
400	iot.vision.RequestError	Request error.	请求失败。

访问错误中心查看更多错误码。