封禁用户 BanUser--云手机-火山引擎

文档中心

立即注册

导航

云手机

封禁用户 BanUser

最近更新时间：2024.07.17 10:42:09首次发布时间：2024.05.08 16:20:06

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1608456935646957568`	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
PodId	String	是	`7299381659819563817`	实例 ID。
UserId	String	是	`user01`	目标封禁用户的 ID。
ForbiddenInterval	Integer	否	`120`	封禁时长，单位：秒，取值范围为 [60, 259290]：若传入值为空或 0 表示允许该用户重新连接云手机；若传入值大于 0，且小于 60，自动调整为 60；若传入值大于 259290，自动调整为 259290。

返回参数

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

请求示例

POST https://open.volcengineapi.com?Action=BanUser&Version=2023-10-30
{
    "ProductId": "1608456935646957568",
    "PodId": "7299381659819563817",
    "UserId": "user01",
    "ForbiddenInterval": 120
}

返回示例

{
    "ResponseMetadata": {
        "Action": "BanUser",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": "success"
}

错误码

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