更新时间:2022-04-11 GMT+08:00
分享

查询直播域名

功能介绍

查询直播域名

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/{project_id}/domain

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

domain

String

直播域名,如果不设置此字段,则返回租户所有的域名信息

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Number

查询结果的总数量

domain_info

Array of DecoupledLiveDomainInfo objects

直播域名列表

表5 DecoupledLiveDomainInfo

参数

参数类型

描述

domain

String

直播域名

domain_type

String

域名类型

vendor

String

CDN厂商

region

String

直播所属直播中心

domain_cname

String

直播域名的CNAME

status

String

直播域名的状态

related_domain

String

播放域名关联的推流域名(只有domain_type为pull的时候有效)

create_time

String

域名创建时间,格式:yyyy-mm-ddThh:mm:ssZ,UTC时间

status_describe

String

状态描述

service_area

String

域名应用区域

  • mainland_china表示中国大陆区域

  • outside_mainland_china表示中国大陆以外区域

  • global表示全球区域

状态码: 404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v1/{project_id}/domain

响应示例

状态码: 200

直播域名查询成功

{
  "total" : 2,
  "domain_info" : [ {
    "domain" : "play.example.huawei.com",
    "domain_type" : "pull",
    "vendor" : "uCDN",
    "domain_cname" : "play.example.huawei.com.c.cdnhwc3.com",
    "region" : "cn-north-1",
    "status" : "on",
    "related_domain" : "publish.example.huawei.com",
    "create_time" : "2020-01-19T02:57:00Z",
    "domain_source" : {
      "protocol" : "rtmp",
      "source_type" : "huawei",
      "sources_priority" : "first",
      "sources" : [ "play.example.huawei.com.o.hwcloudlive.com" ]
    }
  }, {
    "domain" : "publish.example.huawei.com",
    "domain_type" : "push",
    "vendor" : "Tencent",
    "domain_cname" : "publish.example.huawei.com.c.cdnhwc3.com",
    "region" : "cn-north-1",
    "status" : "on",
    "related_domain" : "",
    "create_time" : "2020-01-19T02:58:00Z",
    "domain_source" : {
      "protocol" : "rtmp",
      "source_type" : "huawei",
      "sources_priority" : "first",
      "sources" : [ "publish.example.huawei.com.o.hwcloudlive.com" ]
    }
  } ]
}

状态码: 404

直播域名查询失败

{
  "error_code" : "LIVE.103011019",
  "error_msg" : "Request Illegal"
}

状态码

状态码

描述

200

直播域名查询成功

404

直播域名查询失败

错误码

请参见错误码

分享:

    相关文档

    相关产品

close