1 # ================================================================================
2 # Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved.
3 # ================================================================================
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
15 # ============LICENSE_END=========================================================
17 # ECOMP is a trademark and service mark of AT&T Intellectual Property.
24 title: "deployment-handler API"
27 url: "http://www.apache.org/licenses/LICENSE-2.0.html"
29 High-level API for deploying/undeploying composed DCAE services using Cloudify Manager.
33 description: "version and links"
34 - name: "dcae-deployments"
35 description: "operations on dcae-deployments"
37 description: "policy update API consumed by policy-handler and debug API to find policies on components"
44 description: Returns version information and links to API operations
58 version of API supported by this server
62 version of software running on this server
66 Links to API resources
71 path for the server information endpoint
75 path for the events endpoint
82 List service deployments known to the orchestrator, optionally restricted to a single service type
87 Service type identifier for the type whose deployments are to be listed
96 Success. (Note that if no matching deployments are found, the request is still a success; the
97 deployments array is empty in that case.)
99 $ref: "#/definitions/DCAEDeploymentsListResponse"
103 Problem on the server side. See the message
104 in the response for more details.
106 $ref: "#/definitions/DCAEErrorResponse"
109 Error reported to the dispatcher by a downstream system. See the message
110 in the response for more details.
112 $ref: "#/definitions/DCAEErrorResponse"
116 Error communicating with a downstream system. See the message
117 in the response for more details.
119 $ref: "#/definitions/DCAEErrorResponse"
121 /dcae-deployments/{deploymentId}:
126 Request deployment of a DCAE service
136 Unique deployment identifier assigned by the API client.
144 $ref: "#/definitions/DCAEDeploymentRequest"
151 Success: The content that was posted is valid, the dispatcher has
152 found the needed blueprint, created an instance of the topology in the orchestrator,
153 and started an installation workflow.
155 $ref: "#/definitions/DCAEDeploymentResponse"
159 Bad request: See the message in the response for details.
161 $ref: "#/definitions/DCAEErrorResponse"
165 A service with the specified deployment Id already exists. Using PUT to update the service is not a supported operation.
167 $ref: "#/definitions/DCAEErrorResponse"
171 Bad request: The Content-Type header does not indicate that the content is
174 $ref: "#/definitions/DCAEErrorResponse"
178 Problem on the server side. See the message
179 in the response for more details.
181 $ref: "#/definitions/DCAEErrorResponse"
185 Error reported to the dispatcher by a downstream system. See the message
186 in the response for more details.
188 $ref: "#/definitions/DCAEErrorResponse"
192 Error communicating with a downstream system. See the message
193 in the response for more details.
195 $ref: "#/definitions/DCAEErrorResponse"
201 Uninstall the DCAE service and remove all associated data from the orchestrator.
206 Deployment identifier for the service to be uninstalled.
215 Success: The dispatcher has initiated the uninstall operation.
217 $ref: "#/definitions/DCAEDeploymentResponse"
221 Bad request: See the message in the response for details.
223 $ref: "#/definitions/DCAEErrorResponse"
227 Problem on the server side. See the message
228 in the response for more details.
230 $ref: "#/definitions/DCAEErrorResponse"
234 Error reported to the dispatcher by a downstream system. See the message
235 in the response for more details.
237 $ref: "#/definitions/DCAEErrorResponse"
241 Error communicating with a downstream system. See the message
242 in the response for more details.
244 $ref: "#/definitions/DCAEErrorResponse"
246 /dcae-deployments/{deploymentId}/operation/{operationId}:
251 Get status of a deployment operation
265 description: Status information retrieved successfully
267 $ref: "#/definitions/DCAEOperationStatusResponse"
270 description: The operation information does not exist (possibly because the service has been uninstalled and deleted).
272 $ref: "#/definitions/DCAEErrorResponse"
276 Problem on the server side. See the message
277 in the response for more details.
279 $ref: "#/definitions/DCAEErrorResponse"
283 Error reported to the dispatcher by a downstream system. See the message
284 in the response for more details.
286 $ref: "#/definitions/DCAEErrorResponse"
290 Error communicating with a downstream system. See the message
291 in the response for more details.
293 $ref: "#/definitions/DCAEErrorResponse"
299 description: policy update API consumed by policy-handler
310 $ref: "#/definitions/DCAEPolicyRequest"
315 description: deployment-handler always responds with ok to /policy before processing the request
321 description: debug API to find policies on components
327 description: deployment-handler found components with or without policies in cloudify
332 DCAEDeploymentRequest:
334 Request for deploying a DCAE service.
337 required: [serviceTypeId]
343 The service type identifier (a unique ID assigned by DCAE inventory) for the service to be deployed.
348 Object containing inputs needed by the service blueprint to create an instance of the service.
349 Content of the object depends on the service being deployed.
352 DCAEDeploymentResponse:
354 Response body for a PUT or DELETE to /dcae-deployments/{deploymentId}
357 required: [requestId, links]
363 Unique identifier for the request
366 Links that the API client can access.
372 Link used to retrieve information about the service being deployed
376 Link used to retrieve information about the status of the installation workflow
378 DCAEOperationStatusResponse:
380 Response body for a request for status of an installation or uninstallation operation.
383 required: [requestId, operationType, status]
389 A unique identifier assigned to the request. Useful for tracing a request through logs.
392 Type of operation being reported on. ("install" or "uninstall")
396 Status of the installation or uninstallation operation. Possible values are "processing",
397 "succeeded", and "failed"
401 If status is "failed", this field will be present and contain additional information about the reason the operation failed.
405 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.
411 Link used to retrieve information about the service.
415 Link used to trigger an "uninstall" operation for the service. (Use the DELETE method.)
419 Object reporting an error.
426 description: HTTP status code for the response
430 description: Human-readable description of the reason for the error
433 DCAEDeploymentsListResponse:
435 Object providing a list of deployments
437 required: [requestId, deployments]
443 Unique identifier for the request
452 URL for the service deployment
455 description: policy_body - the whole object received from policy-engine
463 description: unique policy name that contains the version and extension
466 description: stringified int that is autoincremented by policy-engine
469 description: the policy-config - the config data provided by policy owner
473 description: policy object
480 description: unique identifier of policy regardless of its version
483 $ref: "#/definitions/DCAEPolicyBody"
486 description: request to update policies on DCAE components.
495 description: flag to indicate whether the request contains all the policies in PDP or not
501 dictionary of (policy_id -> DCAEPolicy object).
502 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
505 additionalProperties:
506 $ref: "#/definitions/DCAEPolicy"
510 whether policy was removed from policy-engine.
511 dictionary of (policy_id -> true).
512 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
515 additionalProperties:
520 whether policy-engine returned an error on the policy.
521 dictionary of (policy_id -> true).
522 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
525 additionalProperties:
530 on cartchup - list of policy scope_prefix values on wchich
531 the policy-engine experienced an error other than not-found data.
538 on catchup - list of all scope_prefixes used by the policy-handler
539 to retrieve the policies from policy-engine.