查询黑名单列表（GetBlacklist）

接口描述

• 用于查询推流域名下某一App的封禁流信息
• 接口请求频率限制：100次/秒
• 调用方式：HTTP GET

备注

由于历史原因，该接口只能查询新版接口（ForbidStream）封禁的流。

请求参数

参数名	类型	是否必须	描述
Action	String	Y	操作接口名，取值：GetBlacklist
Version	String	Y	版本号，取值：2017-01-01
UniqueName	String	Y	域名空间
App	String	Y	应用名
Pubdomain	String	Y	推流域名

返回参数

参数名	类型	描述
UniqueName	String	域名空间
App	String	应用名
Pubdomain	String	推流域名
Total	Int	记录总数
Stream	String	流名
ForbidTillUnixTime	Int	Unix 时间戳，流禁推的结束时间；-1表示永久禁播
ForbidUnixTime	Int	Unix 时间戳，最后一次拉入黑名单时间
RetCode	Int	响应码 0成功，其他失败
RetMsg	String	响应信息描述

请求示例

http://kls.api.ksyun.com?Action=GetBlacklist&Version=2017-01-01&UniqueName=xxxx&App=live&Pubdomain=xxx.xxx.com

GET /?Action=GetBlacklist&Version=2017-01-01&UniqueName=xxxx&App=live&Pubdomain=xxx.xxx.com HTTP/1.1 
Content-Type: application/json
X-Amz-Date: YOURDATE
Authorization: AWS4-HMAC-SHA256 Credential=YOURAK/YYYYMMDD/cn-beijing-6/kls/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature=SIG
Host: kls.api.ksyun.com

返回示例

{
  "Data": {
    "App": "live",
    "Pubdomain": "xxx.xxx.com",
    "Recs": [
      {
        "ForbidTillUnixTime": -1,
        "ForbidUnixTime": 1497434114,
        "Stream": "aaa"
      }
    ],
    "RetCode": 0,
    "RetMsg": "success",
    "Total": 1,
    "UniqueName": "xxx"
  },
  "RequestId": "1680b7b1-a7ee-4906-8ff1-8ee66b451dc6"
}

错误码

为了帮您快速定位问题，云直播将错误码集中归类，请到错误码中心查看详情。