LiveLive

Compute
Elastic Cloud Server
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
Domain Name Service
VPC Endpoint
Cloud Connect
Enterprise Switch
Security & Compliance
Anti-DDoS
Web Application Firewall
Host Security Service
Data Encryption Workshop
Database Security Service
Advanced Anti-DDoS
Data Security Center
Container Guard Service
Situation Awareness
Managed Threat Detection
Compass
Cloud Certificate Manager
Anti-DDoS Service
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GaussDB NoSQL
GaussDB(for MySQL)
Distributed Database Middleware
GaussDB(for openGauss)
Developer Services
ServiceStage
Distributed Cache Service
Simple Message Notification
Application Performance Management
Application Operations Management
Blockchain
API Gateway
Cloud Performance Test Service
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
DevCloud
ProjectMan
CodeHub
CloudRelease
CloudPipeline
CloudBuild
CloudDeploy
Cloud Communications
Message & SMS
Cloud Ecosystem
Marketplace
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP License Service
Support Plans
Customer Operation Capabilities
Partner Support Plans
Professional Services
enterprise-collaboration
Meeting
IoT
IoT
Intelligent EdgeFabric
DeveloperTools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Help Center> Live> API Reference> Log Management> Obtaining Live Streaming Logs
Updated at: Apr 11, 2022 GMT+08:00

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.

URI

GET /v1/{project_id}/logs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

Table 2 Query Parameters

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

Table 3 Request header 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 when AK/SK-based authentication is used.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory when AK/SK-based authentication is used.

X-Project-Id

No

String

Project ID. This parameter is mandatory when AK/SK-based authentication is used.

Response Parameters

Status code: 200

Table 4 Response body parameters

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.

Table 5 LogInfo

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

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

GET https://{endpoint}/v1/{project_id}/logs?play_domain=play.example.huawei.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.huawei.com",
  "logs" : [ {
    "name" : "play.example.huawei.com_20200304160000.log.gz",
    "url" : "https://xxxxxxxxx/play.example.huawei.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.

Did you find this page helpful?

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel