security_reports

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

Overview

Name	security_reports
Type	Resource
Id	google.apigee.security_reports

Fields

Name	Datatype	Description
created	string	Creation time of the query.
displayName	string	Display Name specified by the user.
envgroupHostname	string	Hostname is available only when query is executed at host level.
error	string	Error is set when query fails.
executionTime	string	ExecutionTime is available only after the query is completed.
queryParams	object	Metadata for the security report.
reportDefinitionId	string	Report Definition ID.
result	object	Contains informations about the security report results.
resultFileSize	string	ResultFileSize is available only after the query is completed.
resultRows	string	ResultRows is available only after the query is completed.
self	string	Self link of the query. Example: /organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
state	string	Query state could be "enqueued", "running", "completed", "expired" and "failed".
updated	string	Output only. Last updated timestamp for the query.

Methods

Name	Accessible by	Required Params	Description
organizations_environments_security_reports_get	SELECT	environmentsId, organizationsId, securityReportsId	Get security report status If the query is still in progress, the state is set to "running" After the query has completed successfully, state is set to "completed"
organizations_environments_security_reports_list	SELECT	environmentsId, organizationsId	Return a list of Security Reports
organizations_environments_security_reports_create	INSERT	environmentsId, organizationsId	Submit a report request to be processed in the background. If the submission succeeds, the API returns a 200 status and an ID that refer to the report request. In addition to the HTTP status 200, the state of "enqueued" means that the request succeeded.

SELECT examples

Return a list of Security Reports

SELECT
created,
displayName,
envgroupHostname,
error,
executionTime,
queryParams,
reportDefinitionId,
result,
resultFileSize,
resultRows,
self,
state,
updated
FROM google.apigee.security_reports
WHERE environmentsId = '{{ environmentsId }}'
AND organizationsId = '{{ organizationsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new security_reports resource.

All Properties

/*+ create */
INSERT INTO google.apigee.security_reports (
environmentsId,
organizationsId,
envgroupHostname,
displayName,
groupByTimeUnit,
limit,
timeRange,
reportDefinitionId,
filter,
csvDelimiter,
metrics,
dimensions,
mimeType
)
SELECT 
'{{ environmentsId }}',
'{{ organizationsId }}',
'{{ envgroupHostname }}',
'{{ displayName }}',
'{{ groupByTimeUnit }}',
'{{ limit }}',
'{{ timeRange }}',
'{{ reportDefinitionId }}',
'{{ filter }}',
'{{ csvDelimiter }}',
'{{ metrics }}',
'{{ dimensions }}',
'{{ mimeType }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: envgroupHostname
      value: string
    - name: displayName
      value: string
    - name: groupByTimeUnit
      value: string
    - name: limit
      value: integer
    - name: timeRange
      value: any
    - name: reportDefinitionId
      value: string
    - name: filter
      value: string
    - name: csvDelimiter
      value: string
    - name: metrics
      value:
        - - name: alias
            value: string
          - name: name
            value: string
          - name: aggregationFunction
            value: string
          - name: value
            value: string
          - name: operator
            value: string
    - name: dimensions
      value:
        - string
    - name: mimeType
      value: string