域名分为推流域名和播流域名两种,主要影响流的接入区域、调度等行为。同一条直播流可以通过多个不同的域名进行推流和播流。
增加一个直播域名。
增加域名时需要指定你的声网项目的 App ID。
POST https://api.sd-rtn.com/v1/projects/{appid}/fls/domains?id={domain}
appid
:String 型,必填。声网为每个开发者提供的 App ID。在声网控制台创建一个项目后即可得到一个 App ID。一个 App ID 是一个项目的唯一标识。
id
:String 型,必填。要增加的域名名称,不支持泛域名。
请求包体为 JSON Object 类型的 data
字段,包含如下字段:
字段 | 类型 | 描述 |
---|---|---|
type |
String | 必填。域名类型:"publish" :推流域名。"play" :播流域名。 |
region |
String | 域名类型设置为 "publish" 时必填。该参数仅适用于推流域名。推流域名使用的声网服务器所在区域:"cn" :中国。"ap" :除中国大陆以外的亚洲区域。"eu" :欧洲。"na" :北美。 |
如果返回的 HTTP 状态码为 201,表示请求成功,响应包体中包含以下字段:
字段 | 类型 | 描述 |
---|---|---|
appid |
String | 声网项目的 App ID。 |
type |
String | 设置的域名类型:"publish" :推流域名。"play" :播流域名。 |
region |
String | 设置的声网服务器所在区域。仅在 type 为 "publish" 时返回。 |
authKey |
String | 防盗链密钥。 |
cname |
String | 域名对应的 cname,你需要在自己的 DNS 托管商处进行配置。 |
如果返回的 HTTP 状态码非 201,表示请求失败。你可以参考 HTTP 状态码了解可能的原因。
请求行
POST https://api.sd-rtn.com/v1/projects/{your_appid}/fls/domains?id={your_domain} HTTP/1.1
请求 body
{
"region": "cn",
"type": "publish"
}
响应行
HTTP/1.1 201 Created
响应 body
{
"appid": "{your appid}",
"name": "{your domain}",
"region": "cn",
"type": "publish"
}
删除一个直播域名。
DELETE https://api.sd-rtn.com/v1/projects/{appid}/fls/domains/{domain}
参数 | 类型 | 描述 |
---|---|---|
appid |
String | 必填。要删除的域名对应的 App ID。 |
domain |
String | 必填。要删除的域名名称。 |
如果返回的 HTTP 状态码为 200,表示请求成功。
如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 HTTP 状态码了解可能的原因。
请求行
DELETE https://api.sd-rtn.com/v1/projects/{your_appid}/fls/domains/{your_domain} HTTP/1.1
响应行
HTTP/1.1 200 OK
获取一个声网项目下所有的直播域名。
GET https://api.sd-rtn.com/v1/projects/{appid}/fls/domains
appid
:String 型,必填。你的声网项目的 App ID。
如果返回的 HTTP 状态码为 200,表示请求成功,响应包体中包含以下字段:
domainList
:JSON Array 型,域名列表。一个域名对应一个 JSON Object,包含以下字段:
字段 | 类型 | 描述 |
---|---|---|
appid |
String | 声网项目的 App ID。 |
name |
String | 域名名称。 |
type |
String | 域名类型。"publish" :推流域名。"play" :播流域名。 |
region |
String | 域名使用的声网服务器所在区域。仅在 type 为 "publish" 时返回。 |
authKey |
String | 防盗链密钥。 |
如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 HTTP 状态码了解可能的原因。
请求行
GET https://api.sd-rtn.com/v1/projects/{your_appid}/fls/domains HTTP/1.1
响应行
HTTP/1.1 200 OK
响应 body
{
"domainList": [
{
"appid": "{your appid}",
"authKey": "{your auth key}",
"name": "{your play domain}",
"type": "play"
},
{
"appid": "{your appid}",
"authKey": "{your auth key}",
"name": "{your publish domain}",
"region": "cn",
"type": "publish"
}
]
}
获取指定域名的属性。
GET https://api.sd-rtn.com/v1/projects/{appid}/fls/domains/{domain}
参数 | 类型 | 描述 |
---|---|---|
appid |
String | 必填。要查询的域名对应的 App ID。 |
domain |
String | 必填。要查询的域名名称。 |
如果返回的 HTTP 状态码为 200,表示请求成功,响应包体中包含以下字段:
字段 | 类型 | 描述 |
---|---|---|
appid |
String | 声网项目的 App ID。 |
name |
String | 域名名称。 |
type |
String | 域名类型。"publish" :推流域名。"play" :播流域名。 |
region |
String | 域名使用的声网服务器所在区域。仅在 type 为 "publish" 时返回。 |
authKey |
String | 防盗链密钥。 |
如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 HTTP 状态码了解可能的原因。
请求行
GET https://api.sd-rtn.com/v1/projects/{your_appid}/fls/domains?id={your_domain} HTTP/1.1
响应行
HTTP/1.1 200 OK
响应 body
{
"appid": "{your appid}",
"authKey": "{your auth key}",
"name": "{your domain}",
"region": "cn",
"type": "publish"
}
状态码 | 描述 |
---|---|
200 | 请求成功。 |
201 | 资源(域名)创建成功。 |
400 | appid 或者 domain 为空。 |
401 | 未经授权的(客户 ID/客户密钥匹配错误)。 |
404 | 服务器无法根据请求找到资源,即请求的域名不存在或者请求的 URI 路径非法。 |
500 | 服务器内部错误,无法完成请求。 |
504 | 服务器内部错误。充当网关或代理的服务器未从远端服务器获取请求。 |