NOTE: Some aspects of this product are in Beta. The hybrid installation options are GA. To join the Beta program, reach out to your Apigee representative.

Deployment

JSON representation
{
  "environment": string,
  "apiProxy": string,
  "revision": string,
  "deployStartTime": string,
  "pods": [
    {
      object (PodStatus)
    }
  ],
  "basePath": string,
  "state": enum (RuntimeState),
  "errors": [
    {
      object (Status)
    }
  ],
  "routeConflicts": [
    {
      object (RoutingConflict)
    }
  ],
  "instances": [
    {
      object (InstanceDeploymentStatus)
    }
  ]
}
Fields
environment

string

Environment.

apiProxy

string

API proxy.

revision

string

API proxy revision.

deployStartTime

string (int64 format)

Time the API proxy was marked deployed in the control plane in millisconds since epoch.

pods[]

object (PodStatus)

Status reported by runtime pods. This field is not populated for List APIs.

basePath

string

Base path for the deployment.

state

enum (RuntimeState)

Current state of the deployment. This field is not populated in List APIs.

errors[]

object (Status)

Errors reported for this deployment. Populated only when state == ERROR. This field is not populated in List APIs.

routeConflicts[]

object (RoutingConflict)

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 deployments basepaths 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. This field is not populated in List APIs.

instances[]

object (InstanceDeploymentStatus)

Status reported by each runtime instance. This field is not populated in List APIs.

PodStatus

JSON representation
{
  "podName": string,
  "appVersion": string,
  "podStatus": string,
  "podStatusTime": string,
  "deploymentStatusTime": string,
  "deploymentTime": string,
  "deploymentStatus": string,
  "statusCode": string,
  "statusCodeDetails": string
}
Fields
podName

string

Name of the pod which is reporting the status.

appVersion

string

Version of the application running in the pod.

podStatus

string

Overall status of the pod (not this specific deployment). Valid values include: - active: Up to date. - stale : Recently out of date.

Pods that have not reported status in a long time are excluded from the output.

podStatusTime

string (int64 format)

Time the pod status was reported in milliseconds since epoch.

deploymentStatusTime

string (int64 format)

Time the deployment status was reported in milliseconds since epoch.

deploymentTime

string (int64 format)

Time the proxy was deployed in milliseconds since epoch.

deploymentStatus

string

Status of the deployment. Valid values include: - deployed: Successful. - error : Failed. - pending : Pod has not yet reported on the deployment.

statusCode

string

Code associated with the deployment status.

statusCodeDetails

string

Human-readable message associated with the status code.

RuntimeState

State of the resource in the runtime.

Enums
RUNTIME_STATE_UNSPECIFIED This value should never be returned.
READY The runtime has loaded the deployment.
PROGRESSING The deployment is not fully ready in the runtime.
ERROR There is an error with the deployment that requires intervention.

InstanceDeploymentStatus

The status of a deployment as reported by a single instance.

JSON representation
{
  "instance": string,
  "deployedRevisions": [
    {
      object (DeployedRevision)
    }
  ],
  "deployedRoutes": [
    {
      object (DeployedRoute)
    }
  ]
}
Fields
instance

string

ID of the instance reporting the status.

deployedRevisions[]

object (DeployedRevision)

Revisions currently deployed in MPs.

deployedRoutes[]

object (DeployedRoute)

The current routes deployed in the ingress routing table. A route which is missing will be shown with no destination environment.

DeployedRevision

Revisions deployed in the MPs.

JSON representation
{
  "revision": string,
  "percentage": integer
}
Fields
revision

string

The proxy revision reported as deployed.

percentage

integer

The percentage of MP replicas reporting this revision

DeployedRoute

A route deployed in the ingress routing table.

JSON representation
{
  "basepath": string,
  "envgroup": string,
  "environment": string,
  "percentage": integer
}
Fields
basepath

string

The basepath in the routing table.

envgroup

string

The envgroup where this route is installed.

environment

string

The destination environment. This will be empty if the route is not yet reported.

percentage

integer

The percentage of ingress replicas reporting this route.