调用接口QueryStreamPushJob查询视频推流任务详情:创建时间、当前推流状态、任务类型、推流地址等。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为50。
说明 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | QueryStreamPushJob | 系统规定参数。取值:QueryStreamPushJob。 |
IotInstanceId | String | 是 | iot-cn-n6w1y59**** | 实例ID。您可在物联网平台控制台的实例概览页签,查看当前实例的ID。 |
JobId | String | 是 | 23********* | 任务ID。 |
ProductKey | String | 否 | a1BwAGV**** | 设备所属产品的ProductKey。 您可以在物联网平台控制台产品页查看或调用QueryProductList查看当前账号下所有产品的信息。 重要 如果传入该参数,需同时传入DeviceName。
|
DeviceName | String | 否 | camera1 | 设备的设备名称。 您可以在物联网平台控制台的设备页查看DeviceName。 重要 如果传入该参数,需同时传入ProductKey。
|
IotId | String | 否 | d7XmBoJhAr88C6PelXDF00**** | 设备的设备ID。物联网平台为该设备颁发的ID,设备的唯一标识符。可调用物联网平台QueryDeviceDetail查询。 重要 IotId作为设备唯一标识符,和ProductKey与DeviceName组合是一一对应的关系。如果传入该参数,则无需传入ProductKey和DeviceName。如果您同时传入IotId和ProductKey与DeviceName组合,则以IotId为准。
|
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 |
类型 |
示例值 |
描述 |
Code | String | 400 | 接口返回码:
|
Data | Struct | 调用成功返回的结果。 |
|
CreateTime | Integer | 1581595942 | 任务创建时间,单位为秒。 |
JobType | Integer | 1 | 推流任务类型。
|
PushStatus | Integer | 1 | 当前推流状态。
|
PushUrl | String | rtmp://**** | 推流地址。 |
StreamType | Integer | 1 | 码流类型。
|
ErrorMessage | String | Request parameter error. | 调用失败时,返回的出错信息。 |
RequestId | String | E55***B7-4***-4***-8***-D3******F565 | 阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true | 是否调用成功:
|
示例
请求示例
http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryStreamPushJob
&IotInstanceId=iot-cn-n6w1y59****
&JobId=23*********
&ProductKey=a1BwAGV****
&DeviceName=camera1
&<公共请求参数>
正常返回示例
XML
格式
<QueryStreamPushJobResponse>
<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>
<Data>
<PushStatus>1</PushStatus>
<StreamType>1</StreamType>
<JobType>1</JobType>
<CreateTime>1581595942</CreateTime>
<PushUrl>rtmp://****</PushUrl>
</Data>
<Code>200</Code>
<Success>true</Success>
</QueryStreamPushJobResponse>
JSON
格式
{
"RequestId": "E55***B7-4***-4***-8***-D3******F565",
"Data": {
"PushStatus": 1,
"StreamType": 1,
"JobType": 1,
"CreateTime": 1581595942,
"PushUrl": "rtmp://****"
},
"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.RequestError | Request error. | 请求失败。 |
400 | iot.vision.JobNotExist | Job not exist or expired. | 任务不存在或已过期。 |
访问错误中心查看更多错误码。
文档内容是否对您有帮助?