DescribeForbidStreamRules
GET
https://rtc-api.zego.im/
查询音视频流封禁规则。
调用频率限制
同一个 AppID 下所有房间:10 次/秒。
说明
如果所查询的 StreamId 不存在、或未设置任何音视频流封禁规则,则返回结果中所有字段值将会为 0,如响应示例中的 streamId2。
注意
调用 DescribeForbidStreamRules
接口,可以查询到当前处于有效期内的规则,也可以查询到已失效的规则。请注意,ZEGO 会不定期清理数据库中的已失效的封禁规则,调用本接口查询得到的失效规则列表可能不完整。
Request
Query Parameters
Action stringrequired
Possible values: [DescribeForbidStreamRules
]
接口原型参数
https://rtc-api.zego.im?Action=DescribeForbidStreamRules
AppId uint32required
💡公共参数。AppId,ZEGO 分配的用户唯一凭证。
SignatureNonce stringrequired
💡公共参数。随机字符串。
Timestamp int64required
💡公共参数。Unix 时间戳,单位为秒。最多允许 10 分钟的误差。
Signature stringrequired
💡公共参数。签名,用于验证请求的合法性。
SignatureVersion stringrequired
Possible values: [2.0
]
Default value: 2.0
💡公共参数。签名版本号。
IsTest string
Possible values: [true
, false
]
Default value: false
💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境,可根据业务需求设置此参数;而之后创建的项目默认是正式环境。
RoomId stringrequired
需要查询的房间 ID。
StreamId string[]required
Possible values: >= 1
, <= 10
需要查询的流 ID,调用本接口查询时不可超过 10 个流 ID。
Responses
- 200
操作成功
- application/json
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
RESPONSEClear