全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

检查流是否在黑名单内

最近更新时间:2024-03-27 15:08:36

检查流是否在黑名单内(CheckBlacklist)

接口描述

  • 用于查询单条流是否被封禁

  • 接口请求频率限制:100次/秒

  • 调用方式:HTTP GET

  • 签名机制

    • Service取值:kls

  • 接入地址:kls.api.ksyun.com︎

备注

由于历史原因,该接口只能查询新版接口(ForbidStream)封禁的流。

请求参数

参数名

类型

是否必须

描述

Action

String

Y

操作接口名,取值:CheckBlacklist

Version

String

Y

版本号,取值:2017-01-01

UniqueName

String

Y

域名空间

App

String

Y

应用名

Pubdomain

String

Y

推流域名

Stream

String

Y

流名

返回参数

参数名

类型

是否必须

描述

CheckResult

Int

Y

检查流名是否在黑名单内,1:在黑名单内,0:不在黑名单内

RetCode

Int

Y

响应码,0:成功,其他失败

RetMsg

String

Y

响应信息描述

请求示例

GET /?Action=CheckBlacklist&Version=2017-01-01&UniqueName=xxx&App=live&Pubdomain=xxx.xxx.com&Stream=bbb 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": {
    "CheckResult": 1,
    "RetCode": 0,
    "RetMsg": "success"
  },
  "RequestId": "bd297352-1ecf-4731-a190-a64111583890"
}

错误码

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

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈