直播云

  • 直播云 > API 文档 > 域名管理API >查询域名信息

    查询域名信息

    最近更新时间:2021-11-01 20:14:47

    接口描述

    查询目标直播域名基本信息和配置信息

    请求参数

    GET /v2/hubs/<hub>/domains/<domain>
    Host: pili.qiniuapi.com 
    Authorization: <QiniuToken>
    Content-Type: application/x-www-form-urlencoded 
    
    参数 类型 必填 描述
    Hub string 直播空间名
    Domain string 域名

    返回数据

    参数 类型 描述
    Domain string 域名
    Type string 域名类型
    Cname string CNAME
    ConnectCallback object 开播回调配置
    ├─ Type string 回调类型,可选回调类型为 :
    留空: 不开启回调功能
    GET: 发送GET请求回调,请求参数携带在query中
    FORM: 发送POST请求回调,请求参数携带在body中,Content-Type 为 application/x-www-form-urlencoded
    JSON: 发送POST请求回调,请求参数携带在body中,Content-Type 为 application/json
    ├─ URL string 回调地址,支持魔法变量
    ├─ Timeout int64 超时时间, 与回调地址的 HTTP 连接超时时间,单位:秒, 默认值为 2 秒,取值范围为 0~10 秒
    ├─ Vars map[string]string 请求参数,支持魔法变量,至少需要一组请求参数,规则解析出错误的会设置成空字段
    ├─RetryTimes int 重试次数,选范围 0~5 次
    ├─RetryInterval int 重试间隔,可选范围 0~5 秒,单位:秒
    ├─SuccessCode int 回调成功的 http code,为 0 表示通配
    ├─ FailCode int 回调失败的 http code,为 0 表示通配,当 SuccessCode 不为 0 的情况下生效
    DisconnectCallback object 断播回调配置
    ├─ Type string 回调类型,可选回调类型为 :
    留空: 不开启回调功能
    GET: 发送GET请求回调,请求参数携带在query中
    FORM: 发送POST请求回调,请求参数携带在body中,Content-Type 为 application/x-www-form-urlencoded
    JSON: 发送POST请求回调,请求参数携带在body中,Content-Type 为 application/json
    ├─ URL string 回调地址,支持魔法变量
    ├─ Timeout int64 超时时间, 与回调地址的 HTTP 连接超时时间,单位:秒, 默认值为 2 秒,配置范围为 0~10 秒
    ├─ Vars map[string]string 请求参数,支持魔法变量,至少需要一组请求参数,规则解析出错误的会设置成空字段
    ├─RetryTimes int 重试次数,选范围 0~5 次
    ├─RetryInterval int 重试间隔,可选范围 0~5 秒,单位:秒
    ├─SuccessCode int 回调成功的 http code,为 0 表示通配
    ├─ FailCode int 回调失败的 http code,为 0 表示通配,当 SuccessCode 不为 0 的情况下生效
    IPLimit object IP 访问限制
    ├─ WhiteList []string 白名单,允许推拉流的 IP 列表(CIDR 类型),配置白名单后,黑名单列表将失效
    ├─ BlackList []string 黑名单,限制推拉流的 IP 列表(CIDR 类型)
    PlaySecurity object 时间戳防盗链配置
    ├─ Type string 防盗链类型,可选防盗链类型为 :
    留空: 默认类型,表示继承直播空间级别配置
    none: 表示关闭鉴权
    tsStartMD5: 有效时间从 TsPart 表示的时间戳开始,到 Range 秒后截止
    tsExpireMD5: 有效时间从现在当前到 TsPart 表示的时间戳为止
    ├─ Key1 string 主密钥
    ├─ Key2 string 副密钥, 两个密钥将同时生效,便于线上业务替换密钥
    ├─ Range int 有效时间,当 防盗链类型 为 “tsStartMD5” 时生效,单位:秒
    ├─ Rule string 签名规则,支持魔法变量的规则,最终签算结果为所有变量的MD5,魔法变量如下 :
    $(key): 用户定义的密钥
    $(path): URL中的path部分
    $(streamKey): URL中的 hub/stream 部分
    $(streamTitle): URL中的 stream 部分
    $(_query): 下划线开头为URL中query字段
    ├─ Rule2 string 签名规则2,两个签名规则将同时生效,便于线上业务更换签名规则
    ├─ TsPart string 时间戳字段,URL中表示时间戳的字段名
    ├─ TsBase int 时间戳进制,可选进制格式为 2-36,即 2 进制到 36 进制,默认使用16进制
    ├─ SignPart string 签名字段,URL中表示token的字段名
    ├─GapDuration int 时间误差值,针对 tsExpireMD5 生效,避免因签算方与服务器本地时间误差造成的鉴权失败
    DisconnectDelay int64 断流延迟配置,单位:秒,针对直播流短时间内闪断重连的情况,不触发断流回调,避免因为短时间内频繁断流造成大量回调
    UrlRewrite object URL 改写规则
    ├─ Rules []object 改写规则列表
    CertEnable bool 是否配置 SSL 证书
    CertName string 证书名称
    Disable bool 域名是否为禁用状态

    示例

    请求体:

    GET /v2/hubs/testhub/domains/pili-publish.testhub.cloudvdn.com HTTP/1.1
    Host: pili.qiniuapi.com 
    Authorization: <QiniuToken>
    Content-Type: application/x-www-form-urlencoded 
    

    返回体:

    200 OK
    
    {
        "domain": "pili-publish.testhub.cloudvdn.com",
        "type": "publishRtmp",
        "cname": "pili-publish.testhub.cloudvdn.com.publish.z0.pili.pilidns.com",
        "connectCallback": {
            "type": "",
            "url": "",
            "timeout": 0,
            "vars": null,
            "retryTimes": 0,
            "retryInterval": 0,
            "successCode": 0,
            "failCode": 0
        },
        "disconnectCallback": {
            "type": "",
            "url": "",
            "timeout": 0,
            "vars": null,
            "retryTimes": 0,
            "retryInterval": 0,
            "successCode": 0,
            "failCode": 0
        },
        "ipLimit": {
            "whitelist": [],
            "blacklist": []
        },
        "playSecurity": {
            "type": "",
            "key1": "",
            "key2": "",
            "range": 0,
            "rule": "",
            "rule2": "",
            "tsPart": "",
            "tsBase": 0,
            "signPart": "",
            "gapDuration": 0
        },
        "disconnectDelay": 0,
        "urlRewrite": {
            "rules": []
        },
        "certEnable": false,
        "certName": "",
        "disable": false
    }
    

    SDK

    七牛云 SDK 已集成该接口功能,可以更方便的调用,前往下载

    以上内容是否对您有帮助?
  • Qvm free helper
    Close