【旧版】暂停/恢复推流 PodMute--云手机-火山引擎

文档中心

立即注册

云手机

请输入

【旧版】实例管理

【旧版】暂停/恢复推流 PodMute

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

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	PodMute
Version	Query	String	是	公共参数，OpenAPI 接口版本	2022-08-01

Body 参数

字段	类型	必填	说明
product_id	string	是	实例所归属的业务 ID
pod_id	string	是	指定实例 ID
display_list	List	否	屏幕 ID 列表（不传则对所有屏幕进行暂停或恢复推流）
mute	bool	是	true: 停止推流 false: 重新推流

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

示例

请求示例

POST https://open.volcengineapi.com?Action=PodMute
&Version=2022-08-01
&<通过header传入的公共请求参数>

{
    "product_id":"1591495366954xxxxxx",
    "pod_id":"7294107154305xxxxxx",
    "mute":true
}

返回示例

{
    "ResponseMetadata": {
        "Action": "PodMute",
        "Region": "cn-north-1",
        "RequestId": "2023102619260761B82CD85D48046AB2C0",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": "success"
}

错误码

错误码	说明	操作建议
8070002	实例暂停失败	检查实例状态，或联系火山引擎云手机技术支持
8070005	实例停止失败	检查实例状态，或联系火山引擎云手机技术支持
8090001	找不到屏幕布局	联系火山引擎云手机技术支持

最近更新时间：2024.06.17 19:36:17

这个页面对您有帮助吗？

有用

无用