debugsessions

Creates, updates, deletes, gets or lists a debugsessions resource.

Overview

Name	debugsessions
Type	Resource
Id	google.apigee.debugsessions

Fields

The following fields are returned by SELECT queries:

organizations_environments_apis_revisions_debugsessions_get

Successful response

Name	Datatype	Description
name	string	A unique ID for this DebugSession.
count	integer (int32)	Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
createTime	string (google-datetime)	Output only. The first transaction creation timestamp, recorded by UAP.
filter	string	Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.
timeout	string (int64)	Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
tracesize	integer (int32)	Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
validity	integer (int32)	Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.

organizations_environments_apis_revisions_debugsessions_list

Successful response

Name	Datatype	Description
id	string	The debug session ID.
timestampMs	string (int64)	The first transaction creation timestamp in millisecond, recorded by UAP.

organizations_apis_debugsessions_list

Successful response

Name	Datatype	Description
id	string	The debug session ID.
apiProxyRevisionId	string	The revision ID of the deployed API proxy.
createTime	string (google-datetime)	The first transaction creation timestamp in millisecond, recorded by UAP.
environmentId	string	The environment ID of the deployed API proxy.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_environments_apis_revisions_debugsessions_get	select	organizationsId, environmentsId, apisId, revisionsId, debugsessionsId		Retrieves a debug session.
organizations_environments_apis_revisions_debugsessions_list	select	organizationsId, environmentsId, apisId, revisionsId	pageSize, pageToken	Lists debug sessions that are currently active in the given API Proxy revision.
organizations_apis_debugsessions_list	select	organizationsId, apisId	pageSize, pageToken	Lists debug sessions that are currently active in the given API Proxy.
organizations_environments_apis_revisions_debugsessions_create	insert	organizationsId, environmentsId, apisId, revisionsId	timeout	Creates a debug session for a deployed API Proxy revision.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
apisId	string
debugsessionsId	string
environmentsId	string
organizationsId	string
revisionsId	string
pageSize	integer (int32)
pageToken	string
timeout	string (int64)

SELECT examples

organizations_environments_apis_revisions_debugsessions_get

Retrieves a debug session.

SELECT
name,
count,
createTime,
filter,
timeout,
tracesize,
validity
FROM google.apigee.debugsessions
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND apisId = '{{ apisId }}' -- required
AND revisionsId = '{{ revisionsId }}' -- required
AND debugsessionsId = '{{ debugsessionsId }}' -- required;

organizations_environments_apis_revisions_debugsessions_list

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

SELECT
id,
timestampMs
FROM google.apigee.debugsessions
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND apisId = '{{ apisId }}' -- required
AND revisionsId = '{{ revisionsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

organizations_apis_debugsessions_list

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

SELECT
id,
apiProxyRevisionId,
createTime,
environmentId
FROM google.apigee.debugsessions
WHERE organizationsId = '{{ organizationsId }}' -- required
AND apisId = '{{ apisId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

organizations_environments_apis_revisions_debugsessions_create

Creates a debug session for a deployed API Proxy revision.

INSERT INTO google.apigee.debugsessions (
data__name,
data__validity,
data__count,
data__tracesize,
data__filter,
data__timeout,
organizationsId,
environmentsId,
apisId,
revisionsId,
timeout
)
SELECT 
'{{ name }}',
{{ validity }},
{{ count }},
{{ tracesize }},
'{{ filter }}',
'{{ timeout }}',
'{{ organizationsId }}',
'{{ environmentsId }}',
'{{ apisId }}',
'{{ revisionsId }}',
'{{ timeout }}'
RETURNING
name,
count,
createTime,
filter,
timeout,
tracesize,
validity
;

Manifest

# Description fields are for documentation purposes
- name: debugsessions
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the debugsessions resource.
    - name: environmentsId
      value: string
      description: Required parameter for the debugsessions resource.
    - name: apisId
      value: string
      description: Required parameter for the debugsessions resource.
    - name: revisionsId
      value: string
      description: Required parameter for the debugsessions resource.
    - name: name
      value: string
      description: >
        A unique ID for this DebugSession.
        
    - name: validity
      value: integer
      description: >
        Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.
        
    - name: count
      value: integer
      description: >
        Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
        
    - name: tracesize
      value: integer
      description: >
        Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
        
    - name: filter
      value: string
      description: >
        Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.
        
    - name: timeout
      value: string
      description: >
        Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
        
    - name: timeout
      value: string (int64)