【旧版】封禁用户 BanUser--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】封禁用户 BanUser

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

封禁或断开指定用户连接云手机实例。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
product_id	String	是	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
pod_id	String	是	实例 ID
user_id	String	是	封禁用户的 ID
forbidden_interval	Int	否	封禁时长，单位：秒，取值范围为 [60,259290]。若传入值为空或 0 表示允许用户重新连接云手机；若传入值大于 0，且小于 60，自动修改为 60；若传入值大于 259290，自动修改为 259290。

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
Result	String	封禁用户成功，返回 success

示例

请求示例

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

{
    "product_id":"1608456935646957568",
    "pod_id":"7299381659819563817",
    "user_id":"user01",
    "forbidden_interval":120
}

返回示例

{
    "ResponseMetadata": {
        "Action": "BanUser",
        "Region": "cn-north-1",
        "RequestId": "2023111419382195547F4E3E45A66E9F65",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": "success"
}