You need to enable JavaScript to run this app.
导航
直播间维度封禁或解禁 IP 地址
最近更新时间:2025.01.24 10:43:12首次发布时间:2025.01.24 10:43:12

调用 UpdateActivityIpBanStatus 接口,在指定直播间内封禁或解禁一个或多个 IP 地址。封禁后,任何使用被封禁 IP 的观众将无法进入或继续停留在该直播间。

注意事项

  • 请求频率:单用户请求频率限制为 30 次/秒
  • 使用限制:单个直播间中,被封禁的 IP 地址数量上限为 1000。单次接口调用最多支持封禁或解禁 50 个 IP 地址。

请求说明

  • 请求方式:POST
  • 请求地址:https://livesaas.volcengineapi.com/?Action=UpdateActivityIpBanStatus&Version=2023-08-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringUpdateActivityIpBanStatus接口名称。当前 API 的名称为 UpdateActivityIpBanStatus
VersionString2023-08-01接口版本。当前 API 的版本为 2023-08-01

Body

参数类型是否必选示例值描述
ActivityIdLong181917****140099直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

BanStatus

Integer

1

封禁或解禁 IP 地址。取值如下:

  • 0:解禁
  • 1:封禁
IpsArray of String["123.**.**.1", "124.*.*.3"]封禁或解禁的 IP 地址列表。您可调用 ListUserBehaviorDataAPIV2 接口,通过返回参数 IP 获取 IP 地址。

返回参数

参数类型示例值描述
StatusBooleantrue是否成功封禁或解禁 IP 地址。成功返回 true

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityIpBanStatus&Version=2023-08-01
{
    "ActivityId": 181917****140099,
    "BanStatus": 1,
    "Ips": [
        "123.**.**.1",
        "124.*.*.3"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateActivityIpBanStatus",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1735982834
    },
    "Result": {
        "Status": true
    }
}

错误码

下表提供了该接口特有的错误码,公共错误码请参见公共错误码错误码文档。

状态码错误码错误信息说明
400InvalidParameter.ArrayOverLimitThe array length exceeds the limit.Ips 数组中的元素个数超出上限 50。请减少数组中的元素个数。
400InvalidParameter.IPUnbannedAll ip has been unbanned in the activity.Ips 数组中的所有 IP 地址均已被解禁。请修改 Ips 中的 IP 地址并重试。
400InvalidParameter.IPBannedAll ip has been banned in the activity.Ips 数组中的所有 IP 地址均已被封禁。请修改 Ips 中的 IP 地址并重试。
400QuotaExceeded.IpOverLimitIp has exceeded the quota.当前直播间中,被封禁的 IP 地址数量已超出上限 1000。请减少 Ips 中的 IP 地址数量,或者解禁部分 IP 地址。