Перейти к основному содержимому
API docs by Redocly

Cloud Logging API (v1.0.0)

Managing groups, streams and events for Cloud Logging

Events

List events

Authorizations:
X-Auth-Token
query Parameters
group
required
string [ 1 .. 512 ] characters

The name of the log group.

stream
required
string [ 1 .. 512 ] characters

The name of the log stream.

start
integer >= 0

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.

end
integer >= 0

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not included.

order
string
Default: "desc"
Enum: "asc" "desc"

The order of messages in the response. If the value is asc, the earliest log events are returned first. If the value is desc, latest log events are returned first.

next
string

The token for the next set of items to be return. The token can direct in both directions, forward and backward. You received this token from a previous response (pages.next or pages.prev).

limit
integer [ 1 .. 10000 ]
Default: 10000

The maximum number of log events returned.

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "pages": {
    }
}

Groups

List groups

Authorizations:
X-Auth-Token
query Parameters
pattern
string [ 1 .. 512 ] characters

If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

prefix
string [ 1 .. 512 ] characters

The prefix to match. pattern and prefix are mutually exclusive. Only one of these parameters can be passed.

next
string non-empty

The token for the next set of items to be return. You received this token from a previous response (pages.next).

limit
integer [ 1 .. 50 ]
Default: 50

The maximum number of items returned.

Responses

Response samples

Content type
application/json
{
  • "groups": [
    ],
  • "pages": {
    }
}

Delete group

Authorizations:
X-Auth-Token
Request Body schema: application/json
required

Payload

object (group.DeleteGroup)
name
string

Responses

Request samples

Content type
application/json
{
  • "group": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Streams

List streams

Authorizations:
X-Auth-Token
query Parameters
group
required
string [ 1 .. 512 ] characters

The name of the log group.

prefix
string [ 1 .. 512 ] characters

The prefix to match.

next
string non-empty

The token for the next set of items to be return. You received this token from a previous response (pages.next).

order
string
Default: "asc"
Enum: "asc" "desc"

The order of log streams in the response. If value is asc, results are returned in ascending order.

limit
integer [ 1 .. 50 ]
Default: 50

The maximum number of log streams returned.

Responses

Response samples

Content type
application/json
{
  • "streams": [
    ],
  • "pages": {
    }
}

Delete stream

Authorizations:
X-Auth-Token
Request Body schema: application/json
required

Payload

object (stream.DeleteStream)
object (stream.Group)
name
string

Responses

Request samples

Content type
application/json
{
  • "stream": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}