Querying HLS Configurations of Domain Names
Function
Queries HLS configurations of domain names.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/domain/hls
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
push_domain |
Yes |
String |
Ingest domain name |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
No |
String |
User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
|
Authorization |
No |
String |
Authentication information. This parameter is mandatory for AK/SK authentication. |
|
X-Sdk-Date |
No |
String |
Time when the request is sent. This parameter is mandatory for AK/SK authentication. |
|
X-Project-Id |
No |
String |
Project ID. This parameter is mandatory for AK/SK authentication. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
push_domain |
String |
Ingest domain name |
|
application |
Array of PushDomainApplication objects |
Ingest domain name app configuration |
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
String |
App name. The default value is live. |
|
hls_fragment |
Integer |
HLS segment duration, in second. |
|
hls_ts_count |
Integer |
Number of TS segments in each M3U8 file |
|
hls_min_frags |
Integer |
Minimum number of TS segments in each M3U8 file |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error Code |
|
error_msg |
String |
Error description |
Example Requests
Queries HLS configurations of domain names.
GET https://{endpoint}/v1/{project_id}/domain/hls?push_domain=push.example.com
Example Responses
Status code: 200
HLS configurations of domain names queried.
{
"push_domain" : "push.example.com",
"application" : [ {
"name" : "live",
"hls_fragment" : 2,
"hls_ts_count" : 3,
"hls_min_frags" : 3
} ]
}
Status code: 400
Invalid parameter.
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
HLS configurations of domain names queried. |
|
400 |
Invalid parameter. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
