Container Service API Operations Index

Container Service API Operations Index

All available Container Service API Operations

Adapter

Generic DELETE to access xenon Adapter API

Generic GET to access xenon Adapter API

Generic PATCH to access xenon Adapter API

Generic POST to access xenon Adapter API

Generic PUT to access xenon Adapter API

Api

Catalog Request Callback Controller.post Submission Extension

Performs additional actions post submission.

Catalog Request Callback Controller.rollback Request

Handles the direction to rollback a rejected request from the Service Catalog.

Catalog Request Callback Controller.submit Request

Handles submitted Request from the Service Catalog to the Container service.

Catalog Request Callback Controller.validate Request

Handles the validation callback for an unsubmitted Request from the Service Catalog. This callback is used to both validate the request as well obtain additional properties if needed before the request is submitted.

Composition Callback Request Controller.allocate Component

Accepts a new request to allocate a Container component from composition service.

Composition Callback Request Controller.create

Accepts a new request to provision a Container component type from composition service.

Composition Callback Request Controller.deallocate Component

Accepts a new request to deallocate a Container component from composition service.

Container Resource Controller.get Resource

Retrieves a single resource by its unique identifier.

Network Callback Request Controller.allocate Component

Accepts a new request to allocate a Container Network component from network service.

Network Callback Request Controller.deallocate Component

Accepts a new request to deallocate a Container Network component from network service.

Network Callback Request Controller.submit Request

Accepts a new request from network service to provision or perform a day-2 operation on a Network component type.

Retrieves collection Of resources By resource type.

Retrieves collection of resources by resource type.

Triggers data collection Of all hosts and associated containers per containerType and related provider.

Triggers data collection of all hosts and associated containers per containerType and related provider.

Triggers full data collection.

Triggers full data collection.

Authentication

Create Auth Credentials Service State

Creates a AuthCredentialsServiceState.

Delete Auth Credentials Service State

Deletes a AuthCredentialsServiceState.

Get Auth Credentials Service State

Retrieves a AuthCredentialsServiceState.

List Auth Credentials Service State

Retrieves all AuthCredentialsServiceStates.

Patch Auth Credentials Service State

Patches a AuthCredentialsServiceState.

Update Auth Credentials Service State

Updates a AuthCredentialsServiceState.

Business Groups

Group Tenant Controller.get

Retrieves the Business Group and Tenant info from the identity-service and transformed in group property.

Group Tenant Controller.list

Retrieves all Business Group and Tenant infos from the identity-service and transformed in group property.

Closures

Create Closure Description

Creates a ClosureDescription.

Create Closure State

Creates a ClosureState.

Delete Closure Description

Deletes a ClosureDescription.

Delete Closure State

Deletes a ClosureState.

Get Closure Description

Retrieves a ClosureDescription.

Get Closure State

Retrieves a ClosureState.

List Closure Description

Retrieves all ClosureDescriptions.

List Closure State

Retrieves all ClosureStates.

Patch Closure Description

Patches a ClosureDescription.

Patch Closure State

Patches a ClosureState.

Runs a Closure.

Update Closure Description

Updates a ClosureDescription.

Update Closure State

Updates a ClosureState.

Cluster

Add Cluster Host

Add host to cluster.

Creates a cluster.

Delete a cluster.

List All Clusters

Retrieves all clusters.

List Cluster Hosts

Retrieves all hosts for a given cluster.

Update a cluster.

Remove Cluster Host

Remove host from cluster.

Retrieve Cluster

Retrieve a cluster.

Composite

Clone Composite Description

Creates a clone of the CompositeDescription.

Create Composite Component

Creates a CompositeComponent.

Create Composite Description

Creates a CompositeDescription.

Delete Composite Component

Deletes a CompositeComponent.

Delete Composite Description

Deletes a CompositeDescription.

Export Composite Description

Exports the Composite Description in YAML format.

Get Composite Component

Retrieves a CompositeComponent.

Get Composite Description

Retrieves a CompositeDescription or the images of it's descriptions as CompositeDescriptionImages.

Import Composite Description

Imports the YAML content as a Composite Description.

List Composite Component

Retrieves all CompositeComponents.

List Composite Description

Retrieves all CompositeDescriptions.

Patch Composite Component

Patches a CompositeComponent.

Patch Composite Description

Patches a CompositeDescription.

Update Composite Component

Updates a CompositeComponent.

Update Composite Description

Updates a CompositeDescription.

Compute Management

Create Compute State

Creates a ComputeState.

Delete Compute State

Deletes a ComputeState.

Get Compute State

Retrieves a ComputeState.

List Compute State

Retrieves all ComputeStates.

Patch Compute State

Patches a ComputeState.

Update Compute State

Updates a ComputeState.

Config Properties

Create Configuration State

Creates a ConfigurationState.

Delete Configuration State

Deletes a ConfigurationState.

Get Configuration State

Retrieves a ConfigurationState.

List Configuration States

Retrieves all ConfigurationStates.

Patch Configuration State

Patches a ConfigurationState.

Update Configuration State

Updates a ConfigurationState.

Container

Create Container Description

Creates a ContainerDescription.

Create Container Network Description

Creates a ContainerNetworkDescription.

Create Container Network State

Creates a ContainerNetworkState.

Create Container State

Creates a ContainerState.

Create Container Type

Creates a ContainerType.

Create Container Volume Description

Creates a ContainerVolumeDescription.

Create Container Volume State

Creates a ContainerVolumeState.

Create Or Update Container Type

Creates or updates a ContainerType.

Delete Container Description

Deletes a ContainerDescription.

Delete Container Network Description

Deletes a ContainerNetworkDescription.

Delete Container Network State

Deletes a ContainerNetworkState.

Delete Container State

Deletes a ContainerState.

Delete Container Type

Deletes a ContainerType with the given ID.

Delete Container Volume Description

Deletes a ContainerVolumeDescription.

Delete Container Volume State

Deletes a ContainerVolumeState.

Get Catalog Resource Item

Retrieves a catalog item related to the container item.

Get Catalog Resource Item

Retrieves a catalog item related to the container item.

Get Catalog Resource Item

Retrieves a catalog item related to the container item.

Get Container Description

Retrieves a ContainerDescription.

Get Container Network Description

Retrieves a ContainerNetworkDescription.

Get Container Network State

Retrieves a ContainerNetworkState.

Get Container State

Retrieves a ContainerState.

Get Container Stats

Retrieves a ServiceStats for container instance.

Get Container Stats

Use ContainerStats endpoint (resources/container-stats) for getting the stats of a container.

Get Container Type

Retrieves a ContainerType.

Get Container Volume Description

Retrieves a ContainerVolumeDescription.

Get Container Volume State

Retrieves a ContainerVolumeState.

List Container Description

Retrieves all ContainerDescriptions.

List Container Network Description

Retrieves all ContainerNetworkDescriptions.

List Container Network State

Retrieves all ContainerNetworkStates.

List Container State

Retrieves all ContainerStates.

List Container Types

Retrieves all ContainerType with specified paging, sorting and filtering parameters.

List Container Volume Description

Retrieves all ContainerVolumeDescriptions.

List Container Volume State

Retrieves all ContainerVolumeState.

Patch Container Description

Patches a ContainerDescription.

Patch Container Network Description

Patches a ContainerNetworkDescription.

Patch Container Network State

Patches a ContainerNetworkState.

Patch Container State

Patches a ContainerState.

Patch Container Volume Description

Patches a ContainerVolumeDescription.

Patch Container Volume State

Patches a ContainerVolumeState.

Publishes A container description To catalog.

Publishes a container description to catalog.

Update Container Description

Updates a ContainerDescription.

Update Container Host Spec

Helper method for adding and validating container hosts.

Update Container Network Description

Updates a ContainerNetworkDescription.

Update Container Network State

Updates a ContainerNetworkState.

Update Container State

Updates a ContainerState.

Update Container Volume Description

Updates a ContainerVolumeDescription.

Update Container Volume State

Updates a ContainerVolumeState.

Data Collection

Patch Container Host Data Collection State

Patches a ContainerHostDataCollectionState.

Deployment Policy

Create Deployment Policy

Creates a DeploymentPolicy.

Delete Deployment Policy

Deletes a DeploymentPolicy.

Get Deployment Policy

Retrieves a DeploymentPolicy.

List Deployment Policies

Retrieves all DeploymentPolicies.

Patch Deployment Policy

Patches a DeploymentPolicy.

Update Deployment Policy

Updates a DeploymentPolicy.

Elastic Placement Zone

Create Elastic Placement Zone Configuration State

Creates an ElasticPlacementZoneConfigurationState.

Create Elastic Placement Zone State

Creates an ElasticPlacementZoneState.

Delete Elastic Placement Zone Configuration State

Deletes an ElasticPlacementZoneConfigurationState.

Delete Elastic Placement Zone State

Deletes an ElasticPlacementZoneState.

Get Elastic Placement Zone Configuration State

Retrieves an ElasticPlacementZoneConfigurationState.

Get Elastic Placement Zone State

Retrieves an ElasticPlacementZoneState.

List Elastic Placement Zone Configuration State

Retrieves all ElasticPlacementZoneConfigurationStates.

List Elastic Placement Zone State

Retrieves all ElasticPlacementZoneStates.

Patch Elastic Placement Zone Configuration State

Patches an ElasticPlacementZoneConfigurationState.

Patch Elastic Placement Zone State

Patches an ElasticPlacementZoneState.

Update Elastic Placement Zone Configuration State

Updates an ElasticPlacementZoneConfigurationState.

Update Elastic Placement Zone State

Updates an ElasticPlacementZoneState.

Events

Create Event Log State

Creates a EventLogState.

Delete Event Log State

Deletes a EventLogState.

Get Event Log State

Retrieves a EventLogState.

List Event Log State

Retrieves all EventLogStates.

Patch Event Log State

Patches a EventLogState.

Update Event Log State

Updates a EventLogState.

Log

Get Log Service State

Retrieves a LogServiceState.

Notifications

Get Notifications

Retrieves request and eventlog notifications.

Placements

Create Group Resource Placement State

Creates a GroupResourcePlacementState.

Delete Group Resource Placement State

Deletes a GroupResourcePlacementState.

Get Group Resource Placement State

Retrieves a GroupResourcePlacementState.

List Group Resource Placement State

Retrieves all GroupResourcePlacementStates.

Patch Group Resource Placement State

Patches a GroupResourcePlacementState.

Update Group Resource Placement State

Updates a GroupResourcePlacementState.

Post

The service accepts post request with long uri as body. Then a get request is sent using the uri in the body. The service workarounds an issue when the uri is too long and netty does not accept it

Registry

Create Registry State

Creates a RegistryState.

Delete Registry State

Deletes a RegistryState.

Get Registry State

Retrieves a RegistryState.

List Registry State

Retrieves all RegistryStates.

Patch Registry State

Patches a RegistryState.

Update Registry Host Spec

Helper method for adding and validating docker registries.

Update Registry State

Updates a RegistryState.

Request Status

Delete Container Request Status

Deletes a ContainerRequestStatus.

Get Container Request Status

Retrieves a ContainerRequestStatus.

List Container Request Status

Retrieves all ContainerRequestStatuss.

Patch Container Request Status

Patches a ContainerRequestStatus.

Requests

Create Request Broker State

Creates a RequestBrokerState.

Delete Request Broker State

Deletes a RequestBrokerState.

Get Request Broker State

Retrieves a RequestBrokerState.

List Request Broker State

Retrieves all RequestBrokerStates.

Patch Request Broker State

Patches a RequestBrokerState.

Update Request Broker State

Updates a RequestBrokerState.

Resource Pool

Create Resource Pool State

Creates a ResourcePoolState.

Delete Resource Pool State

Deletes a ResourcePoolState.

Get Resource Pool State

Retrieves a ResourcePoolState.

List Resource Pool State

Retrieves all ResourcePoolStates.

Patch Resource Pool State

Patches a ResourcePoolState.

Update Resource Pool State

Updates a ResourcePoolState.

Service Document

Create Service Document Delete Task State

Creates a ServiceDocumentDeleteTaskState.

Delete Service Document Delete Task State

Deletes a ServiceDocumentDeleteTaskState.

Get Service Document Delete Task State

Retrieves a ServiceDocumentDeleteTaskState.

List Service Document Delete Task State

Retrieves all ServiceDocumentDeleteTaskState.

Patch Service Document Delete Task State

Patches a ServiceDocumentDeleteTaskState.

Update Service Document Delete Task State

Updates a ServiceDocumentDeleteTaskState.

Ssl

Create Ssl Trust Certificate State

Creates a SslTrustCertificateState.

Create Ssl Trusted Certificate State

Creates a SslTrustedCertificateState.

Delete Ssl Trust Certificate State

Deletes a SslTrustCertificateState.

Delete Ssl Trusted Certificate State

Deletes a SslTrustedCertificateState.

Get Ssl Trust Certificate State

Retrieves a SslTrustCertificateState.

Get Ssl Trusted Certificate State

Retrieves a SslTrustedCertificateState.

List Ssl Trust Certificate State

Retrieves all SslTrustCertificateStates.

List Ssl Trusted Certificate State

Retrieves all SslTrustedCertificateStates.

Patch Ssl Trust Certificate State

Patches a SslTrustCertificateState.

Patch Ssl Trusted Certificate State

Patches a SslTrustedCertificateState.

Ssl Trust Import Controller.update

Imports and transforms a Server certificate from URI and store if valid and accepted.

Update Ssl Trust Certificate State

Updates a SslTrustCertificateState.

Update Ssl Trusted Certificate State

Updates a SslTrustedCertificateState.

Tagging

Create Tag Assignment Request

Creates a TagAssignmentRequest.

Create Tag State

Creates a TagState.

Delete Tag State

Deletes a TagState.

Retrieves a TagState.

Retrieves all TagStates.

Patch Tag State

Patches a TagState.

Update Tag State

Updates a TagState.