文档

CreateStreamPushJob

更新时间:
一键部署

调用接口CreateStreamPushJob创建视频推流任务。

QPS限制

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

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String CreateStreamPushJob

系统规定参数。取值:CreateStreamPushJob。

IotInstanceId String iot-cn-n6w1y59****

实例ID。您可在物联网平台控制台的实例概览页签,查看当前实例的ID。

PushUrl String rtmp://****

推流地址,限制长度为500个字节。

ProductKey String a1BwAGV****

设备所属产品的ProductKey

您可以在物联网平台控制台产品页查看或调用QueryProductList查看当前账号下所有产品的信息。

重要 如果传入该参数,需同时传入DeviceName
DeviceName String camera1

设备的名称。

您可以在物联网平台控制台的设备页查看DeviceName

重要 如果传入该参数,需同时传入ProductKey
IotId String d7XmBoJhAr88C6PelXDF00****

设备的设备ID。物联网平台为该设备颁发的ID,设备的唯一标识符。可调用物联网平台QueryDeviceDetail查询。

重要 IotId作为设备唯一标识符,和ProductKeyDeviceName组合是一一对应的关系。如果传入该参数,则无需传入ProductKeyDeviceName。如果您同时传入IotIdProductKeyDeviceName组合,则以IotId为准。
StreamType Integer 0

码流类型。

  • 0(默认):主码流 。
  • 1:辅码流。
JobType Integer 1

推流任务类型。

  • 1(默认):持续型任务。
  • 2:触发式任务,中断后结束。

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

返回数据

名称

类型

示例值

描述

Code String 403

接口返回码:

  • 200:表示成功。
  • 其它:表示错误码。错误码详情,请参见错误码
Data Struct

调用成功返回的结果。

JobId String 23***********

任务ID。

ErrorMessage String Request forbidden.

调用失败时,返回的出错信息。

RequestId String E55***B7-4***-4***-8***-D3******F565

阿里云为该请求生成的唯一标识符。

Success Boolean true

是否调用成功:

  • true:调用成功。
  • false:调用失败。

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=CreateStreamPushJob
&IotInstanceId=iot-cn-n6w1y59****
&ProductKey=a1BwAGV****
&DeviceName=camera1
&PushUrl=rtmp://****
&<公共请求参数>

正常返回示例

XML格式

<CreateStreamPushJobResponse>
  <RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>
  <Data>
        <JobId>23***********</JobId>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</CreateStreamPushJobResponse>

JSON格式

{
    "RequestId": "E55***B7-4***-4***-8***-D3******F565",
    "Data": {
        "JobId": "23***********"
    },
    "Code": 200,
    "Success": true
}

错误码

HttpCode

错误码

错误信息

描述

400 iot.vision.RequestParamError Request parameter error. 请求参数错误。
403 iot.vision.RequestAuthFailed Request auth failed. 请求鉴权失败。
403 iot.vision.RequestForbidden Request forbidden. 请求被禁止。
429 iot.vision.RequestTrafficControl Request traffic control. 请求太频繁被限流。
400 iot.vision.RequestFailed Request failed. 请求失败。
400 iot.vision.StreamPushFailed Stream push failed. 推流失败。
400 iot.vision.DeviceOffline Device is offline. 设备不在线。
400 iot.vision.DeviceNotStreaming Device is not streaming. 设备未推流。
400 iot.vision.ConcurrencyExceedLimit Concurrency exceed the limit. 并发数超过限额。

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

  • 本页导读 (1)
文档反馈