查询直播流粒度封禁 -

调用DescribeStreamLocationBlock查询直播流粒度封禁信息。

使用说明

先获取直播播放域名，再调用本接口查询直播流粒度封禁信息。

QPS限制

本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见视频直播API QPS限制。

请求参数

参数名	类型	是否必须	说明
Action	String	是	操作接口名，系统规定参数，取值：DescribeStreamLocationBlock。
DomainName	String	是	播放域名。
AppName	String	否	直播流所属应用名称。
StreamName	String	否	直播流名称。
BlockType	String	否	封禁方式，blacklist：黑名单，whitelist：白名单。
PageNum	Integer	否	取得第几页，默认1。
PageSize	Integer	否	每页大小，最大100，取值：1~100之间的任意整数。

返回参数

名称	类型	描述
RequestId	String	请求ID。
Count	Integer	符合条件的总个数。
PageNum	Integer	分页的页码。
PageSize	Integer	每页大小。
TotalPage	Integer	总页数。
StreamBlockList	StreamBlock[]	详细信息。
DomainName	String	加速域名。
AppName	String	封禁的应用名称。
StreamName	String	封禁的流名称。
BlockType	String	封禁方式，blacklist：黑名单，whitelist：白名单。
LocationList	String	封禁区域，如CN，AS多个以逗号隔开。
Status	Integer	封禁状态，0：未开始，1：正在封禁，2：成功，3：失败，4：过期，5：删除中。
ReleaseTime	String	失效时间，UTC时间。
UpdateTime	String	最后修改时间，UTC时间。

特殊错误码

错误代码	描述	Http 状态码	语义
InternalError	The request processing has failed due to some unknown error.	500	后台发生未知错误。
InvalidDomain.NotFound	The domain provided does not exist in our records.	404	当前账户下未查到域名。
InvalidParam	Parameter invalid.	400	参数错误。

示例

请求示例：

https://live.aliyuncs.com?Action=DescribeStreamLocationBlock&DomainName=example.com&<公共请求参数>

返回示例：

{
    "RequestId": "0D70427D-91E4-4349-AAD3-5511A5BB823B",
    "Count": 2,
    "StreamBlockList": {
        "StreamBlock": [
            {
                "DomainName": "example.com",
                "AppName": "test",
                "StreamName": "test",
                "BlockType": "whitelist",
                "LocationList": "CN,AS",
                "Status": 2,
                "ReleaseTime": "2023-03-14T03:02:48Z"
            },
            {
                "DomainName": "example.com",
                "AppName": "test",
                "StreamName": "test1",
                "BlockType": "whitelist",
                "LocationList": "CN,AS",
                "Status": 2,
                "ReleaseTime": "2023-03-14T03:02:48Z"
            }
        ]
	}
}