调用 UpdateActivityIpBanStatus
接口,在指定直播间内封禁或解禁一个或多个 IP 地址。封禁后,任何使用被封禁 IP 的观众将无法进入或继续停留在该直播间。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateActivityIpBanStatus | 接口名称。当前 API 的名称为 UpdateActivityIpBanStatus 。 |
Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ActivityId | Long | 是 | 181917****140099 | 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。 |
BanStatus | Integer | 是 |
| 封禁或解禁 IP 地址。取值如下:
|
Ips | Array of String | 是 | ["123.**.**.1", "124.*.*.3"] | 封禁或解禁的 IP 地址列表。您可调用 ListUserBehaviorDataAPIV2 接口,通过返回参数 IP 获取 IP 地址。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Status | Boolean | true | 是否成功封禁或解禁 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 } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter.ArrayOverLimit | The array length exceeds the limit. | Ips 数组中的元素个数超出上限 50。请减少数组中的元素个数。 |
400 | InvalidParameter.IPUnbanned | All ip has been unbanned in the activity. | Ips 数组中的所有 IP 地址均已被解禁。请修改 Ips 中的 IP 地址并重试。 |
400 | InvalidParameter.IPBanned | All ip has been banned in the activity. | Ips 数组中的所有 IP 地址均已被封禁。请修改 Ips 中的 IP 地址并重试。 |
400 | QuotaExceeded.IpOverLimit | Ip has exceeded the quota. | 当前直播间中,被封禁的 IP 地址数量已超出上限 1000。请减少 Ips 中的 IP 地址数量,或者解禁部分 IP 地址。 |