Method: organizations.environments.apis.revisions.debugsessions.list

Lists debug sessions that are currently active in the given API Proxy revision.

HTTP request

GET https://apigee.googleapis.com/v1/{parent=organizations/*/environments/*/apis/*/revisions/*}/debugsessions

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}.

Authorization requires the following IAM permission on the specified resource parent:

  • apigee.tracesessions.list

Query parameters

Parameters
pageSize

integer

Maximum number of debug sessions to return. The page size defaults to 25.

pageToken

string

Page token, returned from a previous debugsessions.list call, that you can use to retrieve the next page.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "sessions": [
    {
      object (Session)
    }
  ],
  "nextPageToken": string
}
Fields
sessions[]

object (Session)

Session info that includes debug session ID and the first transaction creation timestamp.

nextPageToken

string

Page token that you can include in a ListDebugSessionsRequest to retrieve the next page. If omitted, no subsequent pages exist.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

Session

Session carries the debug session id and its creation time.

JSON representation
{
  "id": string,
  "timestampMs": string
}
Fields
id

string

The debug session ID.

timestampMs

string (int64 format)

The first transaction creation timestamp in millisecond, recoreded by UAP.