Skip to main content

queries

Overview

Namequeries
TypeResource
Idgoogle.apigee.queries

Fields

NameDatatypeDescription
namestringAsynchronous Query Name.
createdstringCreation time of the query.
envgroupHostnamestringHostname is available only when query is executed at host level.
errorstringError is set when query fails.
executionTimestringExecutionTime is available only after the query is completed.
queryParamsobject
reportDefinitionIdstringAsynchronous Report ID.
resultobject
resultFileSizestringResultFileSize is available only after the query is completed.
resultRowsstringResultRows is available only after the query is completed.
selfstringSelf link of the query. Example: /organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
statestringQuery state could be "enqueued", "running", "completed", "failed".
updatedstringLast updated timestamp for the query.

Methods

NameAccessible byRequired ParamsDescription
organizations_environments_queries_getSELECTenvironmentsId, organizationsId, queriesIdGet query 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_queries_listSELECTenvironmentsId, organizationsIdReturn a list of Asynchronous Queries
organizations_environments_queries_createINSERTenvironmentsId, organizationsIdSubmit a query to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the state of "enqueued" means that the request succeeded.