Version: 4.0.0
High-level API for deploying/deploying composed services using Cloudify Manager.
| Path | Operation | Description |
|---|---|---|
| / | GET | |
| /dcae-deployments | GET | |
| /dcae-deployments/{deploymentId} | DELETE | |
| PUT | ||
| /dcae-deployments/{deploymentId}/operation/{operationId} | GET |
Get API version information and links to API operations
Success
version of API supported by this server
version of software running on this server
Links to API resources
path for the server information endpoint
path for the events endpoint
List service deployments known to the orchestrator, optionally restricted to a single service type
| serviceTypeId | Service type identifier for the type whose deployments are to be listed |
query | string |
Success. (Note that if no matching deployments are found, the request is still a success; the deployments array is empty in that case.)
Problem on the server side. See the message in the response for more details.
Error reported to the dispatcher by a downstream system. See the message in the response for more details.
Error communicating with a downstream system. See the message in the response for more details.
Uninstall the DCAE service and remove all associated data from the orchestrator.
| deploymentId | Deployment identifier for the service to be uninstalled. |
path | string |
Success: The dispatcher has initiated the uninstall operation.
Bad request: See the message in the response for details.
Problem on the server side. See the message in the response for more details.
Error reported to the dispatcher by a downstream system. See the message in the response for more details.
Error communicating with a downstream system. See the message in the response for more details.
Request deployment of a DCAE service
application/json
| deploymentId | Unique deployment identifier assigned by the API client. |
path | string |
application/json
Success: The content that was posted is valid, the dispatcher has found the needed blueprint, created an instance of the topology in the orchestrator, and started an installation workflow.
Bad request: See the message in the response for details.
A service with the specified deployment Id already exists. Using PUT to update the service is not a supported operation.
Bad request: The Content-Type header does not indicate that the content is 'application/json'
Problem on the server side. See the message in the response for more details.
Error reported to the dispatcher by a downstream system. See the message in the response for more details.
Error communicating with a downstream system. See the message in the response for more details.
Get status of a deployment operation
| deploymentId | path | string | ||
| operationId | path | string |
Status information retrieved successfully
The operation information does not exist (possibly because the service has been uninstalled and deleted).
Problem on the server side. See the message in the response for more details.
Error reported to the dispatcher by a downstream system. See the message in the response for more details.
Error communicating with a downstream system. See the message in the response for more details.
Request for deploying a DCAE service.
The service type identifier (a unique ID assigned by DCAE inventory) for the service to be deployed.
Object containing inputs needed by the service blueprint to create an instance of the service. Content of the object depends on the service being deployed.
Response body for a PUT or DELETE to /dcae-deployments/{deploymentId}
Unique identifier for the request
Links that the API client can access.
Link used to retrieve information about the service being deployed
Link used to retrieve information about the status of the installation workflow
Object providing a list of deployments
Unique identifier for the request
URL for the service deployment
Object reporting an error.
HTTP status code for the response
Human-readable description of the reason for the error
Response body for a request for status of an installation or uninstallation operation.
A unique identifier assigned to the request. Useful for tracing a request through logs.
Type of operation being reported on. ("install" or "uninstall")
Status of the installation or uninstallation operation. Possible values are "processing", "succeeded", and "failed"
If status is "failed", this field will be present and contain additional information about the reason the operation failed.
If the operation succeeded, links that the client can follow to take further action. Note that a successful "uninstall" operation removes the DCAE service instance completely, so there are no possible further actions, and no links.
Link used to retrieve information about the service.
Link used to trigger an "uninstall" operation for the service. (Use the DELETE method.)