5.1 创建直播域名
功能介绍
可单独创建直播播放域名或推流域名，每个租户最多可配置64条域名记录。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1/{project_id}/domain
表5-1 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID。
请求参数
表5-2 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token，使用Token鉴权方 式时必选。通过调用IAM服务获 取用户Token接口获取（响应消 息头中X-Subject-Token的 值）。
表5-3 请求 Body 参数
参数 是否必选 参数类型 描述
domain 是 String 直播域名
domain_type 是 String 域名类型
● pull表示播放域名
● push表示推流域名
region 是 String 直播所属的直播中心
service_area 否 String 域名应用区域
● mainland_china表示中国大 陆区域
● outside_mainland_china表 示中国大陆以外区域
● global表示全球区域
响应参数
状态码： 201
表5-4 响应 Body 参数
参数 参数类型 描述
domain String 直播域名 domain_type String 域名类型
● pull表示播放域名
● push表示推流域名 domain_cnam
e String 直播域名的CNAME
参数 参数类型 描述
region String 直播所属直播中心 status String 直播域名的状态
create_time String 域名创建时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间 status_describ
e String 状态描述
service_area String 域名应用区域
● mainland_china表示中国大陆区域
● outside_mainland_china表示中国大陆以外区 域
● global表示全球区域
状态码： 400
表5-5 响应 Body 参数
参数 参数类型 描述
error_code String 错误码 error_msg String 错误描述
请求示例
POST https://{endpoint}/v1/{project_id}/domain { "domain" : "play.example.huawei.com", "domain_type" : "pull",
"region" : "cn-north-1"
}
响应示例
状态码： 201 直播域名创建成功
{ "domain" : "play.example.huawei.com", "domain_type" : "pull",
"domain_cname" : "play.example.huawei.com.c.cdnhwc3.com", "region" : "cn-north-1",
"status" : "configuring",
"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" ] }}
状态码： 400 参数错误
{ "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal"
}
状态码
状态码 描述
201 直播域名创建成功
400 参数错误
错误码
请参见错误码。
5.2 删除直播域名
功能介绍
删除域名。只有在域名停用（off）状态时才能删除。
调试
您可以在API Explorer中调试该接口。
URI
DELETE /v1/{project_id}/domain
表5-6 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID。
表5-7 Query 参数
参数 是否必选 参数类型 描述
domain 是 String 直播域名
请求参数
表5-8 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token，使用Token鉴权方 式时必选。通过调用IAM服务获 取用户Token接口获取（响应消 息头中X-Subject-Token的 值）。
响应参数
状态码： 400
表5-9 响应 Body 参数
参数 参数类型 描述
error_code String 错误码 error_msg String 错误描述
请求示例
DELETE https://{endpoint}/v1/{project_id}/domain?domain=play.example.huawei.com
响应示例
状态码： 400 直播域名删除失败
{ "error_code" : "LIVE.103011022", "error_msg" : "Request Illegal"
}
状态码
状态码 描述
204 直播域名删除成功 400 直播域名删除失败
错误码
请参见错误码。
5.3 修改直播域名
功能介绍
修改直播播放、RTMP推流加速域名相关信息
调试
您可以在API Explorer中调试该接口。
URI
PUT /v1/{project_id}/domain
表5-10 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID。
请求参数
表5-11 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token，使用Token鉴权方 式时必选。通过调用IAM服务获 取用户Token接口获取（响应消 息头中X-Subject-Token的 值）。。
表5-12 请求 Body 参数
参数 是否必选 参数类型 描述
domain 是 String 直播域名，不允许修改
status 否 String 直播域名状态，通过修改此字
段，实现域名的启用和停用；域 名处于“配置中”状态时，不允 许对该域名执行启停操作
响应参数
状态码： 200
表5-13 响应 Body 参数
参数 参数类型 描述
domain String 直播域名 domain_type String 域名类型
● pull表示播放域名
● push表示推流域名 domain_cnam
e String 直播域名的CNAME
region String 直播所属直播中心 status String 直播域名的状态
create_time String 域名创建时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间 status_describ
e String 状态描述
service_area String 域名应用区域
● mainland_china表示中国大陆区域
● outside_mainland_china表示中国大陆以外区 域
● global表示全球区域
状态码： 400
表5-14 响应 Body 参数
参数 参数类型 描述
error_code String 错误码 error_msg String 错误描述
请求示例
PUT https://{endpoint}/v1/{project_id}/domain { "domain" : "play.example.huawei.com", "status" : "off"
}
响应示例
状态码： 200 直播域名修改成功
{ "domain" : "play.example.huawei.com", "domain_type" : "pull",
"domain_cname" : "play.example.huawei.com.c.cdnhwc3.com", "region" : "cn-north-1",
"status" : "off",
"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" ] }}
状态码： 400 参数错误
{ "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal"
}
状态码
状态码 描述
200 直播域名修改成功
400 参数错误
错误码
请参见错误码。
5.4 查询直播域名
功能介绍
查询直播域名
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/domain
表5-15 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID。
表5-16 Query 参数
参数 是否必选 参数类型 描述
domain 否 String 直播域名，如果不设置此字段，
则返回租户所有的域名信息
请求参数
表5-17 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token，使用Token鉴权方 式时必选。通过调用IAM服务获 取用户Token接口获取（响应消 息头中X-Subject-Token的 值）。
响应参数
状态码： 200
表5-18 响应 Body 参数
参数 参数类型 描述
total Number 查询结果的总数量 domain_info Array of
DecoupledLiv eDomainInfo objects
直播域名列表
表5-19 DecoupledLiveDomainInfo
参数 参数类型 描述
domain String 直播域名
参数 参数类型 描述 domain_type String 域名类型 vendor String CDN厂商
region String 直播所属直播中心 domain_cnam
e String 直播域名的CNAME
status String 直播域名的状态 related_domai
n String 播放域名关联的推流域名（只有domain_type为 pull的时候有效）
create_time String 域名创建时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间 status_describ
e String 状态描述
service_area String 域名应用区域
● mainland_china表示中国大陆区域
● outside_mainland_china表示中国大陆以外区 域
● global表示全球区域
状态码： 404
表5-20 响应 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"
}
您可以在API Explorer中调试该接口。
URI
PUT /v1/{project_id}/domains_mapping
表5-21 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID。
表5-22 Query 参数
参数 是否必选 参数类型 描述
specify_projec
t 否 String op账号需要携带的特定
project_id，当使用op账号时该 值为所操作租户的project_id
请求参数
表5-23 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token，使用Token鉴权方 式时必选。通过调用IAM服务获 取用户Token接口获取（响应消 息头中X-Subject-Token的 值）。
表5-24 请求 Body 参数
参数 是否必选 参数类型 描述
pull_domain 是 String 直播播放域名
push_domain 是 String 直播播放域名关联的推流域名
响应参数
状态码： 200
表5-25 响应 Body 参数
参数 参数类型 描述
pull_domain String 直播播放域名
push_domain String 直播播放域名关联的推流域名
状态码： 404
表5-26 响应 Body 参数
参数 参数类型 描述
error_code String 错误码 error_msg String 错误描述
请求示例
PUT https://{endpoint}/v1/{project_id}/domains_mapping { "pull_domain" : "play.example.huawei.com",
"push_domain" : "publish.example.huawei.com"
}
响应示例
状态码： 200 直播域名映射成功
{ "pull_domain" : "play.example.huawei.com", "push_domain" : "publish.example.huawei.com"
}
状态码： 404 直播域名映射失败
{ "error_code" : "LIVE.103011019", "error_msg" : "Request Illegal"
}
状态码
状态码 描述
200 直播域名映射成功 404 直播域名映射失败
错误码
请参见错误码。
5.6 删除直播域名映射关系
功能介绍
将播放域名和推流域名的域名映射关系删除
调试
您可以在API Explorer中调试该接口。
URI
DELETE /v1/{project_id}/domains_mapping 表5-27 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID。
表5-28 Query 参数
参数 是否必选 参数类型 描述
specify_projec
t 否 String op账号需要携带的特定
project_id，当使用op账号时该 值为所操作租户的project_id pull_domain 是 String 直播播放域名
push_domain 是 String 直播推流域名
请求参数
表5-29 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token，使用Token鉴权方 式时必选。通过调用IAM服务获 取用户Token接口获取（响应消 息头中X-Subject-Token的 值）。
响应参数
状态码： 400
表5-30 响应 Body 参数
参数 参数类型 描述
error_code String 错误码 error_msg String 错误描述
请求示例
DELETE https://{endpoint}/v1/{project_id}/domains_mapping?
pull_domain=play.example.huawei.com&push_domain=publish.example.huawei.com
响应示例
状态码： 400
直播域名映射关系删除失败
{ "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal"
}
状态码
状态码 描述
200 直播域名映射关系删除成功 400 直播域名映射关系删除失败
错误码
请参见错误码。
6 转码模板管理
6.1 创建直播转码模板