暂停/恢复实例推流 PodMute--云手机-火山引擎

文档中心

立即注册

导航

云手机

暂停/恢复实例推流 PodMute

最近更新时间：2024.05.08 15:07:03首次发布时间：2024.05.08 15:07:03

暂停或恢复指定实例推流。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=PodMute&Version=2023-10-30

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`PodMute`	接口名称。当前 API 的名称为 `PodMute`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1591495366954xxxxxx`	实例所归属的业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
PodId	String	是	`7294107154305xxxxxx`	实例 ID，可通过调用 `ListPod` 接口获取。
Mute	Boolean	是	`true`	暂停/恢复推流。 true：暂停推流。 false：恢复推流。
DisplayList	Array of String	否	`["single-display-landscape", "single-display-portrait"]`	屏幕 ID 列表。若将该参数置空则对表示所有屏幕进行暂停或恢复推流。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://open.volcengineapi.com?Action=PodMute&Version=2023-10-30
{
    "ProductId": "1591495366954xxxxxx",
    "PodId": "7294107154305xxxxxx",
    "Mute": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280xxxxxx",
        "Action": "PodMute",
        "Version": "2023-10-30",
        "Service": "ACEP",
        "Region": "cn-north-1"
    },
    "Result": "success"
}

错误码

您可访问公共错误码，获取更多错误码信息。