API error messages
Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogChange historyCI buildCI build detailCI configurationCI eventCI jobClusterComponentsCredentialCredential providerCustom filterDashboardDashboard columnDatabase configurationData retention policyDeployer applicationDevOps Insight data sourceDirectory providerDynamic environmentEmail configurationEmail notifierEnvironmentEnvironment tierGatewayGroupInstalling or upgrading remote agentsJobKerberos keytabMicroserviceMicroservice mappingMiscellaneousObjectObject tagsParameterPersonaPipelinePluginPlugin configurationPlugin catalogProcedureProcessProcess dependencyProcess stepProjectPropertyReleaseReportReporting filterReport object associationReport object attributeReport object typeResourceRolling deployScheduleSCM syncServerServer settings categoryService accounts for webhooksSessionSingle sign-on for OpenID ConnectSingle sign-on for SAMLSnapshotsTier mapTriggerUserUser emailUtility resourceWait dependencyWebhook resultWidgetWidget filter overrideWorkflowWorkflow definitionWork itemsWorkspaceZone
Perl API response and element glossary
Introduction
Examples
Troubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcibuildcibuilddetailciconfigurationcieventclustercompliancecomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Cluster

4 minute readReference

createCluster

Creates a new cluster configuration object for a microservice application.

Arguments

Argument Name Type Description

projectName

String

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

clusterName

String

(Required) The name of the cluster.

definitionParameters

Map

Cluster definition parameter.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

environmentName

String

Name of the environment which owns this cluster.

pluginConfigurationName

String

Name of the plugin configuration.

pluginKey

String

Name of the plugin key.

pluginProjectName

String

Plugin project name.

providerClusterName

String

Name of the cluster on the provider platform.

providerProjectName

String

Name of the project on the provider platform.

provisionParameters

Map

Provision parameter.

provisionProcedure

String

Provision procedure name.

Positional arguments

projectName, clusterName

Usage

ec-perl

$cmdr->createCluster(<projectName>, <clusterName>, {<optionals>});
▼

ectool

ectool createCluster projectName clusterName [optionals]
▼

deleteCluster

Deletes a cluster reference.

Arguments

Argument Name Type Description

projectName

String

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

clusterName

String

(Required) The name of the cluster.

environmentName

String

Name of the environment which owns this cluster.

Positional arguments

projectName, clusterName

Usage

ec-perl

$cmdr->deleteCluster(<projectName>, <clusterName>, {<optionals>});
▼

ectool

ectool deleteCluster projectName clusterName [optionals]
▼

doActionOnRealtimeCluster

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

Arguments

Argument Name Type Description

projectName

String

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

clusterName

String

(Required) The name of the cluster.

objectId

String

(Required) 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

String

(Required) 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.

action

String

(Required) 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.

actionParameters

Map

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

environmentName

String

Name of the environment which owns this cluster.

Positional arguments

projectName, clusterName, objectId, objectType, action

Usage

ec-perl

$cmdr->doActionOnRealtimeCluster(<projectName>, <clusterName>, <objectId>, <objectType>, <action>, {<optionals>});
▼

ectool

ectool doActionOnRealtimeCluster projectName clusterName objectId objectType action [optionals]
▼

getCluster

Retrieves a cluster reference by name.

Arguments

Argument Name Type Description

projectName

String

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

clusterName

String

(Required) The name of the cluster.

environmentName

String

Name of the environment which owns this cluster.

Positional arguments

projectName, clusterName

Usage

ec-perl

$cmdr->getCluster(<projectName>, <clusterName>, {<optionals>});
▼

ectool

ectool getCluster projectName clusterName [optionals]
▼

getClusters

Retrieves all cluster references in a project or environment.

Arguments

Argument Name Type Description

projectName

String

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

environmentName

String

Name of the environment which owns this cluster.

Positional arguments

projectName

Usage

ec-perl

$cmdr->getClusters(<projectName>, {<optionals>});
▼

ectool

ectool getClusters projectName [optionals]
▼

getRealtimeClusterDetails

Retrieves details for the given object from the container platform for the given CloudBees CD/RO cluster reference.

Arguments

Argument Name Type Description

projectName

String

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

clusterName

String

(Required) The name of the cluster.

objectId

String

(Required) 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

String

(Required) 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.

environmentName

String

Name of the environment which owns this cluster.

Positional arguments

projectName, clusterName, objectId, objectType

Usage

ec-perl

$cmdr->getRealtimeClusterDetails(<projectName>, <clusterName>, <objectId>, <objectType>, {<optionals>});
▼

ectool

ectool getRealtimeClusterDetails projectName clusterName objectId objectType [optionals]
▼

getRealtimeClusterTopology

Retrieves cluster topology from the container platform for the given CloudBees CD/RO cluster reference.

Arguments

Argument Name Type Description

projectName

String

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

clusterName

String

(Required) The name of the cluster.

environmentName

String

Name of the environment which owns this cluster.

Positional arguments

projectName, clusterName

Usage

ec-perl

$cmdr->getRealtimeClusterTopology(<projectName>, <clusterName>, {<optionals>});
▼

ectool

ectool getRealtimeClusterTopology projectName clusterName [optionals]
▼

modifyCluster

Modifies an existing cluster configuration object for a microservice application.

Arguments

Argument Name Type Description

projectName

String

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

clusterName

String

(Required) The name of the cluster.

definitionParameters

Map

Cluster definition parameter.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

environmentName

String

Name of the environment which owns this cluster.

newName

String

New name for an existing object that is being renamed.

pluginConfigurationName

String

Name of the plugin configuration.

pluginKey

String

Name of the plugin key.

pluginProjectName

String

Plugin project name.

providerClusterName

String

Name of the cluster on the provider platform.

providerProjectName

String

Name of the project on the provider platform.

provisionParameters

Map

Provision parameter.

provisionProcedure

String

Provision procedure name.

Positional arguments

projectName, clusterName

Usage

ec-perl

$cmdr->modifyCluster(<projectName>, <clusterName>, {<optionals>});
▼

ectool

ectool modifyCluster projectName clusterName [optionals]
▼
CI job
Components