【旧版】停止推流 PodStop--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】停止推流 PodStop

最近更新时间：2024.06.17 19:36:17首次发布时间：2023.06.14 12:45:15

停止指定实例推流，释放实例资源。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
product_id	string	是	实例所归属的业务 ID
pod_id	string	是	指定实例 ID

返回结果

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

示例

请求示例

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

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

返回示例

{
    "ResponseMetadata": {
        "Action": "PodStop",
        "Region": "cn-north-1",
        "RequestId": "202310261932277364FC32F9402E6A694D",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": "success"
}

错误码

错误码	说明	操作建议
8020001	数据库查询失败	检查指定的查询参数是否正确
8060001	实例不存在	检查指定的实例 ID 是否正确
8060002	实例离线	检查实例在线状态
8070005	实例停止失败	检查实例状态，或联系火山引擎云手机技术支持