deployments

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

Overview

Name	deployments
Type	Resource
Id	google.apigee.deployments

Fields

The following fields are returned by SELECT queries:

organizations_apis_revisions_deployments_list

Successful response

Name	Datatype	Description
deployments	array	List of deployments.

organizations_environments_apis_deployments_list

Successful response

Name	Datatype	Description
deployments	array	List of deployments.

organizations_environments_sharedflows_deployments_list

Successful response

Name	Datatype	Description
deployments	array	List of deployments.

organizations_environments_deployments_get

Successful response

Name	Datatype	Description
apiProxy	string	API proxy.
deployStartTime	string (int64)	Time the API proxy was marked deployed in the control plane in millisconds since epoch.
environment	string	Environment.
errors	array	Errors reported for this deployment. Populated only when state == ERROR. Note: This field is displayed only when viewing deployment status.
instances	array	Status reported by each runtime instance. Note: This field is displayed only when viewing deployment status.
pods	array	Status reported by runtime pods. Note: This field is deprecated. Runtime versions 1.3 and above report instance level status rather than pod status.
proxyDeploymentType	string	Output only. The type of the deployment (standard or extensible) Deployed proxy revision will be marked as extensible in following 2 cases. 1. The deployed proxy revision uses extensible policies. 2. If a environment supports flowhooks and flow hook is configured.
revision	string	API proxy revision.
routeConflicts	array	Conflicts in the desired state routing configuration. The presence of conflicts does not cause the state to be ERROR, but it will mean that some of the deployment's base paths are not routed to its environment. If the conflicts change, the state will transition to PROGRESSING until the latest configuration is rolled out to all instances. Note: This field is displayed only when viewing deployment status.
serviceAccount	string	The full resource name of Cloud IAM Service Account that this deployment is using, eg, projects/-/serviceAccounts/{email}.
state	string	Current state of the deployment. Note: This field is displayed only when viewing deployment status.

organizations_sharedflows_revisions_deployments_list

Successful response

Name	Datatype	Description
deployments	array	List of deployments.

organizations_apis_deployments_list

Successful response

Name	Datatype	Description
deployments	array	List of deployments.

organizations_environments_deployments_list

Successful response

Name	Datatype	Description
deployments	array	List of deployments.

organizations_sharedflows_deployments_list

Successful response

Name	Datatype	Description
deployments	array	List of deployments.

organizations_deployments_list

Successful response

Name	Datatype	Description
deployments	array	List of deployments.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_apis_revisions_deployments_list	select	organizationsId, apisId, revisionsId		Lists all deployments of an API proxy revision.
organizations_environments_apis_deployments_list	select	organizationsId, environmentsId, apisId		Lists all deployments of an API proxy in an environment.
organizations_environments_sharedflows_deployments_list	select	organizationsId, environmentsId, sharedflowsId		Lists all deployments of a shared flow in an environment.
organizations_environments_deployments_get	select	organizationsId, environmentsId, deploymentsId		Gets a particular deployment of Api proxy or a shared flow in an environment
organizations_sharedflows_revisions_deployments_list	select	organizationsId, sharedflowsId, revisionsId		Lists all deployments of a shared flow revision.
organizations_apis_deployments_list	select	organizationsId, apisId		Lists all deployments of an API proxy.
organizations_environments_deployments_list	select	organizationsId, environmentsId	sharedFlows	Lists all deployments of API proxies or shared flows in an environment.
organizations_sharedflows_deployments_list	select	organizationsId, sharedflowsId		Lists all deployments of a shared flow.
organizations_deployments_list	select	organizationsId	sharedFlows	Lists all deployments of API proxies or shared flows.
organizations_environments_apis_revisions_deployments_generate_deploy_change_report	exec	organizationsId, environmentsId, apisId, revisionsId	override	Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment. In addition to the standard validations performed when adding deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being created. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run DeployApiProxy request. For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport, two permissions are required: * apigee.deployments.create on the resource organizations/{org}/environments/{env} * apigee.proxyrevisions.deploy on the resource organizations/{org}/apis/{api}/revisions/{rev}
organizations_environments_apis_revisions_deployments_generate_undeploy_change_report	exec	organizationsId, environmentsId, apisId, revisionsId		Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy. In addition to the standard validations performed when removing deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being removed. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run UndeployApiProxy request. For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport, two permissions are required: * apigee.deployments.delete on the resource organizations/{org}/environments/{env} * apigee.proxyrevisions.undeploy on the resource organizations/{org}/apis/{api}/revisions/{rev}

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
deploymentsId	string
environmentsId	string
organizationsId	string
revisionsId	string
sharedflowsId	string
override	boolean
sharedFlows	boolean

SELECT examples

organizations_apis_revisions_deployments_list

Lists all deployments of an API proxy revision.

SELECT
deployments
FROM google.apigee.deployments
WHERE organizationsId = '{{ organizationsId }}' -- required
AND apisId = '{{ apisId }}' -- required
AND revisionsId = '{{ revisionsId }}' -- required;

organizations_environments_apis_deployments_list

Lists all deployments of an API proxy in an environment.

SELECT
deployments
FROM google.apigee.deployments
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND apisId = '{{ apisId }}' -- required;

organizations_environments_sharedflows_deployments_list

Lists all deployments of a shared flow in an environment.

SELECT
deployments
FROM google.apigee.deployments
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND sharedflowsId = '{{ sharedflowsId }}' -- required;

organizations_environments_deployments_get

Gets a particular deployment of Api proxy or a shared flow in an environment

SELECT
apiProxy,
deployStartTime,
environment,
errors,
instances,
pods,
proxyDeploymentType,
revision,
routeConflicts,
serviceAccount,
state
FROM google.apigee.deployments
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND deploymentsId = '{{ deploymentsId }}' -- required;

organizations_sharedflows_revisions_deployments_list

Lists all deployments of a shared flow revision.

SELECT
deployments
FROM google.apigee.deployments
WHERE organizationsId = '{{ organizationsId }}' -- required
AND sharedflowsId = '{{ sharedflowsId }}' -- required
AND revisionsId = '{{ revisionsId }}' -- required;

organizations_apis_deployments_list

Lists all deployments of an API proxy.

SELECT
deployments
FROM google.apigee.deployments
WHERE organizationsId = '{{ organizationsId }}' -- required
AND apisId = '{{ apisId }}' -- required;

organizations_environments_deployments_list

Lists all deployments of API proxies or shared flows in an environment.

SELECT
deployments
FROM google.apigee.deployments
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND sharedFlows = '{{ sharedFlows }}';

organizations_sharedflows_deployments_list

Lists all deployments of a shared flow.

SELECT
deployments
FROM google.apigee.deployments
WHERE organizationsId = '{{ organizationsId }}' -- required
AND sharedflowsId = '{{ sharedflowsId }}' -- required;

organizations_deployments_list

Lists all deployments of API proxies or shared flows.

SELECT
deployments
FROM google.apigee.deployments
WHERE organizationsId = '{{ organizationsId }}' -- required
AND sharedFlows = '{{ sharedFlows }}';

Lifecycle Methods

organizations_environments_apis_revisions_deployments_generate_deploy_change_report

Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment. In addition to the standard validations performed when adding deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being created. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run DeployApiProxy request. For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport, two permissions are required: * apigee.deployments.create on the resource organizations/{org}/environments/{env} * apigee.proxyrevisions.deploy on the resource organizations/{org}/apis/{api}/revisions/{rev}

EXEC google.apigee.deployments.organizations_environments_apis_revisions_deployments_generate_deploy_change_report 
@organizationsId='{{ organizationsId }}' --required, 
@environmentsId='{{ environmentsId }}' --required, 
@apisId='{{ apisId }}' --required, 
@revisionsId='{{ revisionsId }}' --required, 
@override={{ override }};

organizations_environments_apis_revisions_deployments_generate_undeploy_change_report

Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy. In addition to the standard validations performed when removing deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being removed. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run UndeployApiProxy request. For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport, two permissions are required: * apigee.deployments.delete on the resource organizations/{org}/environments/{env} * apigee.proxyrevisions.undeploy on the resource organizations/{org}/apis/{api}/revisions/{rev}

EXEC google.apigee.deployments.organizations_environments_apis_revisions_deployments_generate_undeploy_change_report 
@organizationsId='{{ organizationsId }}' --required, 
@environmentsId='{{ environmentsId }}' --required, 
@apisId='{{ apisId }}' --required, 
@revisionsId='{{ revisionsId }}' --required;