1 deployment-handler API 4.2.0
2 ============================
11 High-level API for deploying/undeploying composed DCAE services using Cloudify Manager.
21 `Apache 2.0 <http://www.apache.org/licenses/LICENSE-2.0.html>`_
30 operations on dcae-deployments
36 DELETE ``/dcae-deployments/{deploymentId}``
37 -------------------------------------------
46 Uninstall the DCAE service and remove all associated data from the orchestrator.
54 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
55 :widths: 20, 15, 10, 10, 10, 20, 30
57 deploymentId | path | Yes | string | | | Deployment identifier for the service to be uninstalled.
70 Success: The dispatcher has initiated the uninstall operation.
74 Type: :ref:`DCAEDeploymentResponse <d_6157bd3de5c8c7de78f2ab86397667e0>`
78 .. code-block:: javascript
83 "status": "somestring"
85 "requestId": "somestring"
91 Bad request: See the message in the response for details.
95 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
99 .. code-block:: javascript
102 "message": "somestring",
109 Problem on the server side. See the message
110 in the response for more details.
114 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
118 .. code-block:: javascript
121 "message": "somestring",
128 Error reported to the dispatcher by a downstream system. See the message
129 in the response for more details.
133 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
137 .. code-block:: javascript
140 "message": "somestring",
147 Error communicating with a downstream system. See the message
148 in the response for more details.
152 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
156 .. code-block:: javascript
159 "message": "somestring",
167 GET ``/dcae-deployments``
168 -------------------------
177 List service deployments known to the orchestrator, optionally restricted to a single service type
185 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
186 :widths: 20, 15, 10, 10, 10, 20, 30
188 serviceTypeId | query | No | string | | | Service type identifier for the type whose deployments are to be listed
201 Success. (Note that if no matching deployments are found, the request is still a success; the
202 deployments array is empty in that case.)
206 Type: :ref:`DCAEDeploymentsListResponse <d_c51e57d9583f6119caf83dd017cf214c>`
210 .. code-block:: javascript
221 "requestId": "somestring"
227 Problem on the server side. See the message
228 in the response for more details.
232 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
236 .. code-block:: javascript
239 "message": "somestring",
246 Error reported to the dispatcher by a downstream system. See the message
247 in the response for more details.
251 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
255 .. code-block:: javascript
258 "message": "somestring",
265 Error communicating with a downstream system. See the message
266 in the response for more details.
270 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
274 .. code-block:: javascript
277 "message": "somestring",
285 GET ``/dcae-deployments/{deploymentId}/operation/{operationId}``
286 ----------------------------------------------------------------
295 Get status of a deployment operation
303 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
304 :widths: 20, 15, 10, 10, 10, 20, 30
306 deploymentId | path | Yes | string | | |
307 operationId | path | Yes | string | | |
320 Status information retrieved successfully
323 Type: :ref:`DCAEOperationStatusResponse <d_f0103f05736b04468a4f85fe90da2e16>`
327 .. code-block:: javascript
330 "error": "somestring",
332 "self": "somestring",
333 "uninstall": "somestring"
335 "operationType": "somestring",
336 "requestId": "somestring",
337 "status": "somestring"
343 The operation information does not exist (possibly because the service has been uninstalled and deleted).
346 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
350 .. code-block:: javascript
353 "message": "somestring",
360 Problem on the server side. See the message
361 in the response for more details.
365 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
369 .. code-block:: javascript
372 "message": "somestring",
379 Error reported to the dispatcher by a downstream system. See the message
380 in the response for more details.
384 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
388 .. code-block:: javascript
391 "message": "somestring",
398 Error communicating with a downstream system. See the message
399 in the response for more details.
403 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
407 .. code-block:: javascript
410 "message": "somestring",
418 PUT ``/dcae-deployments/{deploymentId}``
419 ----------------------------------------
428 Request deployment of a DCAE service
436 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
437 :widths: 20, 15, 10, 10, 10, 20, 30
439 deploymentId | path | Yes | string | | | Unique deployment identifier assigned by the API client.
447 .. _d_eea14e4929853a5aa415f44cd4868302:
452 Request for deploying a DCAE service.
457 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
458 :widths: 20, 10, 15, 15, 30, 25
460 inputs | No | | | | Object containing inputs needed by the service blueprint to create an instance of the service.
462 Content of the object depends on the service being deployed.
464 serviceTypeId | Yes | string | | | The service type identifier (a unique ID assigned by DCAE inventory) for the service to be deployed.
467 .. _i_08ada55a389e24cd45beef83306fd08e:
472 Object containing inputs needed by the service blueprint to create an instance of the service.
473 Content of the object depends on the service being deployed.
478 .. code-block:: javascript
482 "serviceTypeId": "somestring"
491 Success: The content that was posted is valid, the dispatcher has
492 found the needed blueprint, created an instance of the topology in the orchestrator,
493 and started an installation workflow.
497 Type: :ref:`DCAEDeploymentResponse <d_6157bd3de5c8c7de78f2ab86397667e0>`
501 .. code-block:: javascript
505 "self": "somestring",
506 "status": "somestring"
508 "requestId": "somestring"
514 Bad request: See the message in the response for details.
518 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
522 .. code-block:: javascript
525 "message": "somestring",
532 A service with the specified deployment Id already exists. Using PUT to update the service is not a supported operation.
536 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
540 .. code-block:: javascript
543 "message": "somestring",
550 Bad request: The Content-Type header does not indicate that the content is
555 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
559 .. code-block:: javascript
562 "message": "somestring",
569 Problem on the server side. See the message
570 in the response for more details.
574 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
578 .. code-block:: javascript
581 "message": "somestring",
588 Error reported to the dispatcher by a downstream system. See the message
589 in the response for more details.
593 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
597 .. code-block:: javascript
600 "message": "somestring",
607 Error communicating with a downstream system. See the message
608 in the response for more details.
612 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
616 .. code-block:: javascript
619 "message": "somestring",
646 Returns version information and links to API operations
662 .. _i_2e7b26d45eaa7203222963d454a86a88:
668 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
669 :widths: 20, 10, 15, 15, 30, 25
671 apiVersion | No | string | | | version of API supported by this server
673 links | No | :ref:`links <i_bcea41e897f5de95cd50fa873acb5f65>` | | | Links to API resources
675 serverVersion | No | string | | | version of software running on this server
678 .. _i_bcea41e897f5de95cd50fa873acb5f65:
683 Links to API resources
688 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
689 :widths: 20, 10, 15, 15, 30, 25
691 events | No | string | | | path for the events endpoint
693 info | No | string | | | path for the server information endpoint
699 .. code-block:: javascript
702 "apiVersion": "somestring",
704 "events": "somestring",
707 "serverVersion": "somestring"
717 policy update API consumed by policy-handler and debug API to find policies on components
723 GET ``/policy/components``
724 --------------------------
733 debug API to find policies on components
746 deployment-handler found components with or without policies in cloudify
763 policy update API consumed by policy-handler
771 .. _d_6ea6e6f48a0302e963a67833bbd0ff4a:
776 request to update policies on DCAE components.
780 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
781 :widths: 20, 10, 15, 15, 30, 25
783 catch_up | Yes | boolean | | | flag to indicate whether the request contains all the policies in PDP or not
784 errored_policies | No | | | | whether policy-engine returned an error on the policy.
785 errored_scopes | No | array of string | | | on cartchup - list of policy scope_prefix values on wchich the policy-engine experienced an error other than not-found data.
786 latest_policies | Yes | | | | dictionary of (policy_id -> DCAEPolicy object).
787 removed_policies | Yes | | | | whether policy was removed from policy-engine.
788 scope_prefixes | No | array of string | | | on catchup - list of all scope_prefixes used by the policy-handler to retrieve the policies from policy-engine.
791 .. _i_0e88fa72c5312eaae3990753181ce5fe:
793 **Errored_policies schema:**
796 whether policy-engine returned an error on the policy.
797 dictionary of (policy_id -> true).
798 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
801 Map of {"key":"boolean"}
803 .. _i_cbc40bad95bddbd536eeab0a92f483af:
805 **Latest_policies schema:**
808 dictionary of (policy_id -> DCAEPolicy object).
809 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
812 Map of {"key":":ref:`DCAEPolicy <d_1e3e880a733b457b648bd8c99e6c859c>`"}
816 .. _i_0ce52a29e44aa0cc7929fe7b555551bc:
818 **Removed_policies schema:**
821 whether policy was removed from policy-engine.
822 dictionary of (policy_id -> true).
823 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
826 Map of {"key":"boolean"}
828 .. code-block:: javascript
832 "errored_policies": {},
841 "policyName": "somestring",
842 "policyVersion": "somestring"
844 "policy_id": "somestring"
847 "removed_policies": {},
860 deployment-handler always responds with ok to /policy before processing the request
870 DCAEDeploymentRequest Model Structure
871 -------------------------------------
873 Request for deploying a DCAE service.
878 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
879 :widths: 20, 10, 15, 15, 30, 25
881 inputs | No | | | | Object containing inputs needed by the service blueprint to create an instance of the service.
882 serviceTypeId | Yes | string | | | The service type identifier (a unique ID assigned by DCAE inventory) for the service to be deployed.
889 Object containing inputs needed by the service blueprint to create an instance of the service.
890 Content of the object depends on the service being deployed.
895 .. _d_6157bd3de5c8c7de78f2ab86397667e0:
897 DCAEDeploymentResponse Model Structure
898 --------------------------------------
900 Response body for a PUT or DELETE to /dcae-deployments/{deploymentId}
905 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
906 :widths: 20, 10, 15, 15, 30, 25
908 links | Yes | :ref:`links <i_4a894329f99280d2268e250444b59376>` | | | Links that the API client can access.
910 requestId | Yes | string | | | Unique identifier for the request
913 .. _i_4a894329f99280d2268e250444b59376:
918 Links that the API client can access.
923 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
924 :widths: 20, 10, 15, 15, 30, 25
926 self | No | string | | | Link used to retrieve information about the service being deployed
928 status | No | string | | | Link used to retrieve information about the status of the installation workflow
930 .. _d_c51e57d9583f6119caf83dd017cf214c:
932 DCAEDeploymentsListResponse Model Structure
933 -------------------------------------------
935 Object providing a list of deployments
940 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
941 :widths: 20, 10, 15, 15, 30, 25
943 deployments | Yes | array of :ref:`deployments <i_98a80d81e7d1973d54db7713913d37e8>` | | |
944 requestId | Yes | string | | | Unique identifier for the request
947 .. _i_98a80d81e7d1973d54db7713913d37e8:
949 **Deployments schema:**
954 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
955 :widths: 20, 10, 15, 15, 30, 25
957 href | No | string | | | URL for the service deployment
960 .. _d_74f3f4f847dfb6bd181fcae06ad880b4:
962 DCAEErrorResponse Model Structure
963 ---------------------------------
965 Object reporting an error.
970 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
971 :widths: 20, 10, 15, 15, 30, 25
973 message | No | string | | | Human-readable description of the reason for the error
974 status | Yes | integer | | | HTTP status code for the response
976 .. _d_f0103f05736b04468a4f85fe90da2e16:
978 DCAEOperationStatusResponse Model Structure
979 -------------------------------------------
981 Response body for a request for status of an installation or uninstallation operation.
986 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
987 :widths: 20, 10, 15, 15, 30, 25
989 error | No | string | | | If status is 'failed', this field will be present and contain additional information about the reason the operation failed.
991 links | No | :ref:`links <i_2feace8c1d3584ec637edc0eb1b92699>` | | | 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.
993 operationType | Yes | string | | | Type of operation being reported on. ('install' or 'uninstall')
995 requestId | Yes | string | | | A unique identifier assigned to the request. Useful for tracing a request through logs.
997 status | Yes | string | | | Status of the installation or uninstallation operation. Possible values are 'processing',
1000 .. _i_2feace8c1d3584ec637edc0eb1b92699:
1005 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.
1010 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1011 :widths: 20, 10, 15, 15, 30, 25
1013 self | No | string | | | Link used to retrieve information about the service.
1015 uninstall | No | string | | | Link used to trigger an 'uninstall' operation for the service. (Use the DELETE method.)
1017 .. _d_1e3e880a733b457b648bd8c99e6c859c:
1019 DCAEPolicy Model Structure
1020 --------------------------
1026 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1027 :widths: 20, 10, 15, 15, 30, 25
1029 policy_body | Yes | :ref:`DCAEPolicyBody <d_7ffe00ee1aaae6811199d64ff3fea344>` | | |
1030 policy_id | Yes | string | | | unique identifier of policy regardless of its version
1032 .. _d_7ffe00ee1aaae6811199d64ff3fea344:
1034 DCAEPolicyBody Model Structure
1035 ------------------------------
1037 policy_body - the whole object received from policy-engine
1041 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1042 :widths: 20, 10, 15, 15, 30, 25
1044 config | Yes | :ref:`config <i_ba9593ef6832fb8401f266e173acaa5c>` | | | the policy-config - the config data provided by policy owner
1045 policyName | Yes | string | | | unique policy name that contains the version and extension
1046 policyVersion | Yes | string | | | stringified int that is autoincremented by policy-engine
1048 .. _i_ba9593ef6832fb8401f266e173acaa5c:
1053 the policy-config - the config data provided by policy owner
1057 DCAEPolicyRequest Model Structure
1058 ---------------------------------
1060 request to update policies on DCAE components.
1064 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1065 :widths: 20, 10, 15, 15, 30, 25
1067 catch_up | Yes | boolean | | | flag to indicate whether the request contains all the policies in PDP or not
1068 errored_policies | No | | | | whether policy-engine returned an error on the policy.
1069 errored_scopes | No | array of string | | | on cartchup - list of policy scope_prefix values on wchich the policy-engine experienced an error other than not-found data.
1070 latest_policies | Yes | | | | dictionary of (policy_id -> DCAEPolicy object).
1071 removed_policies | Yes | | | | whether policy was removed from policy-engine.
1072 scope_prefixes | No | array of string | | | on catchup - list of all scope_prefixes used by the policy-handler to retrieve the policies from policy-engine.
1075 **Errored_policies schema:**
1078 whether policy-engine returned an error on the policy.
1079 dictionary of (policy_id -> true).
1080 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
1083 Map of {"key":"boolean"}
1085 **Latest_policies schema:**
1088 dictionary of (policy_id -> DCAEPolicy object).
1089 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
1092 Map of {"key":":ref:`DCAEPolicy <d_1e3e880a733b457b648bd8c99e6c859c>`"}
1096 **Removed_policies schema:**
1099 whether policy was removed from policy-engine.
1100 dictionary of (policy_id -> true).
1101 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
1104 Map of {"key":"boolean"}