Obtaining Live Streaming Logs
Function
This API is used to obtain live streaming logs by domain name. The log events are separated by vertical bars (|) and packaged at an interval of 5 minutes.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/logs
|
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 |
|---|---|---|---|
|
play_domain |
Yes |
String |
Streaming domain name. |
|
start_time |
Yes |
String |
Start time of the query time range. The value is in the format of YYYY-MM-DDTHH:mm:ssZ (UTC time). For example, if you want to query data generated from 16:00:00 on March 4, 2020 GMT+08:00, set this parameter to 2020-03-04T08:00:00Z. Only data of the last three months can be queried. |
|
end_time |
Yes |
String |
End time of the query time range. The value is in the format of YYYY-MM-DDTHH:mm:ssZ (UTC time). For example, if you want to query data generated until 16:00:00 on March 4, 2020 GMT+08:00, set this parameter to 2020-03-04T08:00:00Z. The query time range cannot be longer than 7 days. |
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 |
|---|---|---|
|
total |
Integer |
Total number of records that meet the search criteria. |
|
domain |
String |
Streaming domain name. |
|
logs |
Array of LogInfo objects |
Log list. |
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
String |
Log file name, in the format of {Domain}_{logStartTimeStamp}.log.gz. |
|
url |
String |
Link for downloading the log file. |
|
size |
Long |
Log file size. |
|
start_time |
String |
Start time of the logs in the log file (Beijing time). |
|
end_time |
String |
End time of the logs in the log file (Beijing time). |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error Code |
|
error_msg |
String |
Error description |
Example Requests
Queries playback logs of a domain name.
GET https://{endpoint}/v1/{project_id}/logs?play_domain=play.example.com&start_time=2020-03-04T08:00:00Z&end_time=2020-03-04T09:00:00Z
Example Responses
Status code: 200
Live streaming logs obtained.
{
"total" : 1,
"domain" : "play.example.com",
"logs" : [ {
"name" : "play.example.com_20200304160000.log.gz",
"url" : "https://xxxxxxxxx/play.example.com_20200304160000.log.gz",
"size" : 600,
"start_time" : "2020-03-04T16:00:00+08:00",
"end_time" : "2020-03-04T16:04:59+08:00"
} ]
}
Status code: 400
Incorrect parameter.
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Live streaming logs obtained. |
|
400 |
Incorrect 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.
