Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetContainerLog

Returns the log events of a container of your Amazon Lightsail container service.

If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.

Note

Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas in the AWS General Reference.

Request Syntax


{
   "containerName": "string",
   "endTime": number,
   "filterPattern": "string",
   "pageToken": "string",
   "serviceName": "string",
   "startTime": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

containerName

The name of the container that is either running or previously ran on the container service for which to return a log.

Type: String

Required: Yes

endTime

The end of the time interval for which to get log data.

Constraints:

Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.

For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Type: Timestamp

Required: No

filterPattern

The pattern to use to filter the returned log events to a specific term.

The following are a few examples of filter patterns that you can specify:

To return all log events, specify a filter pattern of "".
To exclude log events that contain the ERROR term, and return all other log events, specify a filter pattern of "-ERROR".
To return log events that contain the ERROR term, specify a filter pattern of "ERROR".
To return log events that contain both the ERROR and Exception terms, specify a filter pattern of "ERROR Exception".
To return log events that contain the ERROR or the Exception term, specify a filter pattern of "?ERROR ?Exception".

Type: String

Required: No

pageToken

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetContainerLog request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Type: String

Required: No

serviceName

The name of the container service for which to get a container log.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$

Required: Yes

startTime

The start of the time interval for which to get log data.

Constraints:

Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.

For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Type: Timestamp

Required: No

Response Syntax


{
   "logEvents": [ 
      { 
         "createdAt": number,
         "message": "string"
      }
   ],
   "nextPageToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

logEvents

An array of objects that describe the log events of a container.

Type: Array of ContainerServiceLogEvent objects

nextPageToken

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetContainerLog request and specify the next page token using the pageToken parameter.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

HTTP Status Code: 400

InvalidInputException

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Note

Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

HTTP Status Code: 400

NotFoundException

Lightsail throws this exception when it cannot find a resource.

HTTP Status Code: 400

ServiceException

A general service exception.

HTTP Status Code: 500

UnauthenticatedException

Lightsail throws this exception when the user has not been authenticated.

HTTP Status Code: 400