doActionOnRealtimeCluster

Back to index

Summary

Perform action on the given object in the container platform for the given CloudBees CD/RO cluster reference.

For a list of object types in CloudBees CD/RO, refer to Object types in CloudBees CD/RO.

projectName

Stringrequired

The name for the project that must be unique among all projects.

environmentName

Stringoptional

Name of the environment which owns this cluster.

clusterName

Stringrequired

The name of the cluster.

action

Stringrequired

The action to be performed on the object within the cluster. The supported values for action may vary by container platform and the type of object. Kubernetes cluster will support viewLogs action on ecp-container object type.

objectId

Stringrequired

The identifier for the object within the cluster for which real-time details will be retrieved. The identifier for the object within the cluster can be obtained using getRealtimeClusterTopology API.

objectType

Stringrequired

The type of object within the cluster for which real-time details will be retrieved. The supported values for object type may vary by container platform. Kubernetes cluster will support ecp-namespace, ecp-service, ecp-pod, and ecp-container object types.

actionParameters

Array<ActionParameter>optional

Parameters passed as arguments for the action that should be performed on the object within the cluster.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.doActionOnRealtimeCluster(
  projectName: "test-projectName",
  clusterName: "test-clusterName",
  action: "test-action",
  objectId: "test-objectId",
  objectType: "test-objectType"
  /* optional arguments */
)▼