调用该接口停止IPC设备推流。

使用说明

  • 调用该接口前，您需要在IPC设备端实现标识符为StopPushStreaming的停止直播物模型服务。若未在IPC设备端实现该服务，或IPC设备收到该服务调用后未正常响应，则IPC设备不会停止推流。物模型的详细信息，请参见什么是物模型。
  • 当IPC设备端无人观看时，无需额外调用该接口，物联网平台会自动触发停止设备推流。
  • 触发录像事件的过程中，调用该接口会造成录像文件间断，请您谨慎使用。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 StopLiveStreaming

系统规定参数。取值：StopLiveStreaming。
IotId String 否 C47T6xwp6ms4bNlkHRWCg4****

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

注意 如果传入该参数，则无需传入ProductKey和DeviceName。IotId作为设备唯一标识符，和ProductKey与DeviceName的组合是一一对应的关系。如果您同时传入IotId和ProductKey与DeviceName的组合，则以IotId为准。
ProductKey String 否 a1BwAGV****

IPC设备所属产品的ProductKey。

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

注意 如果传入该参数，需同时传入DeviceName。
DeviceName String 否 camera1

IPC设备的设备名称。

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

注意 如果传入该参数，需同时传入ProductKey。
StreamType Integer 否 0

码流类型：

  • 0（默认）：主码流。
  • 1：辅码流。
IotInstanceId String 否 iot-cn-n6w1y59****

实例ID。

您可在物联网平台控制台的实例概览页面，查看当前实例的ID。若有ID值，必须传入该ID值，否则调用会失败。

说明 如果公共实例没有ID值，请参见如何获取实例ID。

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

返回数据

名称 类型 示例值 描述
Code String 200

接口返回码：

  • 200：表示成功。
  • 其它：表示错误码。错误码详情，请参见错误码。
ErrorMessage String tenant auth error

调用失败时，返回的出错信息。
RequestId String 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1

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

是否调用成功：

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

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=StopLiveStreaming
&IotId=C47T6xwp6ms4bNlkHRWCg4****
&<公共请求参数>

正常返回示例

XML格式 

<StopLiveStreamingResponse>
      <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
      <Code>200</Code>
      <Success>true</Success>
</StopLiveStreamingResponse>

JSON格式 

{
    "RequestId": "06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
    "Code": "200",
    "Success": true
}

错误码

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