You need to enable JavaScript to run this app.
文档中心
云手机

云手机

复制全文
下载 pdf
云手机操控
封禁用户 BanUser
复制全文
下载 pdf
封禁用户 BanUser
封禁或断开指定客户端用户连接云手机实例。​
请求说明​
  • 请求方式:POST​
  • 请求地址:https://open.volcengineapi.com?Action=BanUser&Version=2025-05-01​
请求参数​
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见 公共参数。​
Query​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
BanUser​
接口名称。当前 API 的名称为 BanUser。​
Version​
String​
是​
2025-05-01​
接口版本。当前 API 的版本为 2025-05-01。​
​
Body​
​
参数​
类型​
是否必选​
示例值​
描述​
ProductId​
String​
是​
1749281594201xxxxxx​
业务 ID,管理云手机资源、开展云手机业务的标识。可登录 云手机控制台,在已创建的业务卡片中获取。​
PodId​
String​
是​
7295222843434xxxxxx​
实例 ID。​
UserId​
String​
是​
user01​
封禁目标用户的 ID。​
ForbiddenInterval​
Integer​
否​
120​
封禁时长。单位为秒,取值范围为 [60, 259290]。​
  • 若传入值为空或 0,表示允许该用户重新连接云手机。​
  • 若传入值大于 0,且小于 60,自动调整为 60。​
  • 若传入值大于 259290,自动调整为 259290。​
IsPreviewStream​
Boolean​
否​
false​
私有参数,停止拉取的流类型。​
  • true:小流。​
  • false:(默认值)大流。​
注意:小流不支持设置封禁时长,即当该参数设置为 true 时,ForbiddenInterval 设置的时长不生效。​
​
返回参数​
本接口无特有的返回参数。更多信息请参见 返回结构。​
请求示例​
​
POST https://open.volcengineapi.com?Action=BanUser&Version=2025-05-01​
{​
"ProductId": "1749281594201xxxxxx",​
"PodId": "7295222843434xxxxxx",​
"UserId": "user01",​
"ForbiddenInterval": 120,​
"IsPreviewStream": false​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"Action": "BanUser",​
"Region": "cn-north-1",​
"Service": "ACEP",​
"Version": "2025-05-01",​
"RequestId": "20230604110420****100232280022D31"​
}​
}​
​
错误码​
您可访问 公共错误码,获取更多错误码信息。​
最近更新时间:2026.03.27 14:54:09
这个页面对您有帮助吗?
有用
有用
无用
无用