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 | :ref:`inputs <i_08ada55a389e24cd45beef83306fd08e>` | | | Object containing inputs needed by the service blueprint to create an instance of the service.
461 Content of the object depends on the service being deployed.
463 serviceTypeId | Yes | string | | | The service type identifier (a unique ID assigned by DCAE inventory) for the service to be deployed.
466 .. _i_08ada55a389e24cd45beef83306fd08e:
471 Object containing inputs needed by the service blueprint to create an instance of the service.
472 Content of the object depends on the service being deployed.
477 .. code-block:: javascript
481 "serviceTypeId": "somestring"
490 Success: The content that was posted is valid, the dispatcher has
491 found the needed blueprint, created an instance of the topology in the orchestrator,
492 and started an installation workflow.
496 Type: :ref:`DCAEDeploymentResponse <d_6157bd3de5c8c7de78f2ab86397667e0>`
500 .. code-block:: javascript
504 "self": "somestring",
505 "status": "somestring"
507 "requestId": "somestring"
513 Bad request: See the message in the response for details.
517 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
521 .. code-block:: javascript
524 "message": "somestring",
531 A service with the specified deployment Id already exists. Using PUT to update the service is not a supported operation.
535 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
539 .. code-block:: javascript
542 "message": "somestring",
549 Bad request: The Content-Type header does not indicate that the content is
554 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
558 .. code-block:: javascript
561 "message": "somestring",
568 Problem on the server side. See the message
569 in the response for more details.
573 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
577 .. code-block:: javascript
580 "message": "somestring",
587 Error reported to the dispatcher by a downstream system. See the message
588 in the response for more details.
592 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
596 .. code-block:: javascript
599 "message": "somestring",
606 Error communicating with a downstream system. See the message
607 in the response for more details.
611 Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>`
615 .. code-block:: javascript
618 "message": "somestring",
645 Returns version information and links to API operations
661 .. _i_2e7b26d45eaa7203222963d454a86a88:
667 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
668 :widths: 20, 10, 15, 15, 30, 25
670 apiVersion | No | string | | | version of API supported by this server
672 links | No | :ref:`links <i_bcea41e897f5de95cd50fa873acb5f65>` | | | Links to API resources
674 serverVersion | No | string | | | version of software running on this server
677 .. _i_bcea41e897f5de95cd50fa873acb5f65:
682 Links to API resources
687 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
688 :widths: 20, 10, 15, 15, 30, 25
690 events | No | string | | | path for the events endpoint
692 info | No | string | | | path for the server information endpoint
698 .. code-block:: javascript
701 "apiVersion": "somestring",
703 "events": "somestring",
706 "serverVersion": "somestring"
716 policy update API consumed by policy-handler and debug API to find policies on components
722 GET ``/policy/components``
723 --------------------------
732 debug API to find policies on components
745 deployment-handler found components with or without policies in cloudify
762 policy update API consumed by policy-handler
770 .. _d_6ea6e6f48a0302e963a67833bbd0ff4a:
775 request to update policies on DCAE components.
779 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
780 :widths: 20, 10, 15, 15, 30, 25
782 catch_up | Yes | boolean | | | flag to indicate whether the request contains all the policies in PDP or not
783 errored_policies | No | :ref:`errored_policies <i_0e88fa72c5312eaae3990753181ce5fe>` | | | whether policy-engine returned an error on the policy.
784 dictionary of (policy_id -> true).
785 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
787 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.
789 latest_policies | Yes | :ref:`latest_policies <i_cbc40bad95bddbd536eeab0a92f483af>` | | | dictionary of (policy_id -> DCAEPolicy object).
790 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
792 removed_policies | Yes | :ref:`removed_policies <i_0ce52a29e44aa0cc7929fe7b555551bc>` | | | whether policy was removed from policy-engine.
793 dictionary of (policy_id -> true).
794 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
796 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.
799 .. _i_0e88fa72c5312eaae3990753181ce5fe:
801 **Errored_policies schema:**
804 whether policy-engine returned an error on the policy.
805 dictionary of (policy_id -> true).
806 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
809 Map of {"key":"boolean"}
811 .. _i_cbc40bad95bddbd536eeab0a92f483af:
813 **Latest_policies schema:**
816 dictionary of (policy_id -> DCAEPolicy object).
817 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
820 Map of {"key":":ref:`DCAEPolicy <d_1e3e880a733b457b648bd8c99e6c859c>`"}
824 .. _i_0ce52a29e44aa0cc7929fe7b555551bc:
826 **Removed_policies schema:**
829 whether policy was removed from policy-engine.
830 dictionary of (policy_id -> true).
831 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
834 Map of {"key":"boolean"}
836 .. code-block:: javascript
840 "errored_policies": {},
849 "policyName": "somestring",
850 "policyVersion": "somestring"
852 "policy_id": "somestring"
855 "removed_policies": {},
868 deployment-handler always responds with ok to /policy before processing the request
877 .. _d_eea14e4929853a5aa415f44cd4868302:
879 DCAEDeploymentRequest Model Structure
880 -------------------------------------
882 Request for deploying a DCAE service.
887 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
888 :widths: 20, 10, 15, 15, 30, 25
890 inputs | No | :ref:`inputs <i_08ada55a389e24cd45beef83306fd08e>` | | | Object containing inputs needed by the service blueprint to create an instance of the service.
891 Content of the object depends on the service being deployed.
893 serviceTypeId | Yes | string | | | The service type identifier (a unique ID assigned by DCAE inventory) for the service to be deployed.
896 .. _i_08ada55a389e24cd45beef83306fd08e:
901 Object containing inputs needed by the service blueprint to create an instance of the service.
902 Content of the object depends on the service being deployed.
907 .. _d_6157bd3de5c8c7de78f2ab86397667e0:
909 DCAEDeploymentResponse Model Structure
910 --------------------------------------
912 Response body for a PUT or DELETE to /dcae-deployments/{deploymentId}
917 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
918 :widths: 20, 10, 15, 15, 30, 25
920 links | Yes | :ref:`links <i_4a894329f99280d2268e250444b59376>` | | | Links that the API client can access.
922 requestId | Yes | string | | | Unique identifier for the request
925 .. _i_4a894329f99280d2268e250444b59376:
930 Links that the API client can access.
935 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
936 :widths: 20, 10, 15, 15, 30, 25
938 self | No | string | | | Link used to retrieve information about the service being deployed
940 status | No | string | | | Link used to retrieve information about the status of the installation workflow
942 .. _d_c51e57d9583f6119caf83dd017cf214c:
944 DCAEDeploymentsListResponse Model Structure
945 -------------------------------------------
947 Object providing a list of deployments
952 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
953 :widths: 20, 10, 15, 15, 30, 25
955 deployments | Yes | array of :ref:`deployments <i_98a80d81e7d1973d54db7713913d37e8>` | | |
956 requestId | Yes | string | | | Unique identifier for the request
959 .. _i_98a80d81e7d1973d54db7713913d37e8:
961 **Deployments schema:**
966 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
967 :widths: 20, 10, 15, 15, 30, 25
969 href | No | string | | | URL for the service deployment
972 .. _d_74f3f4f847dfb6bd181fcae06ad880b4:
974 DCAEErrorResponse Model Structure
975 ---------------------------------
977 Object reporting an error.
982 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
983 :widths: 20, 10, 15, 15, 30, 25
985 message | No | string | | | Human-readable description of the reason for the error
986 status | Yes | integer | | | HTTP status code for the response
988 .. _d_f0103f05736b04468a4f85fe90da2e16:
990 DCAEOperationStatusResponse Model Structure
991 -------------------------------------------
993 Response body for a request for status of an installation or uninstallation operation.
998 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
999 :widths: 20, 10, 15, 15, 30, 25
1001 error | No | string | | | If status is 'failed', this field will be present and contain additional information about the reason the operation failed.
1003 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.
1005 operationType | Yes | string | | | Type of operation being reported on. ('install' or 'uninstall')
1007 requestId | Yes | string | | | A unique identifier assigned to the request. Useful for tracing a request through logs.
1009 status | Yes | string | | | Status of the installation or uninstallation operation. Possible values are 'processing',
1010 'succeeded', and 'failed'
1013 .. _i_2feace8c1d3584ec637edc0eb1b92699:
1018 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.
1023 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1024 :widths: 20, 10, 15, 15, 30, 25
1026 self | No | string | | | Link used to retrieve information about the service.
1028 uninstall | No | string | | | Link used to trigger an 'uninstall' operation for the service. (Use the DELETE method.)
1030 .. _d_1e3e880a733b457b648bd8c99e6c859c:
1032 DCAEPolicy Model Structure
1033 --------------------------
1039 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1040 :widths: 20, 10, 15, 15, 30, 25
1042 policy_body | Yes | :ref:`DCAEPolicyBody <d_7ffe00ee1aaae6811199d64ff3fea344>` | | |
1043 policy_id | Yes | string | | | unique identifier of policy regardless of its version
1045 .. _d_7ffe00ee1aaae6811199d64ff3fea344:
1047 DCAEPolicyBody Model Structure
1048 ------------------------------
1050 policy_body - the whole object received from policy-engine
1054 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1055 :widths: 20, 10, 15, 15, 30, 25
1057 config | Yes | :ref:`config <i_ba9593ef6832fb8401f266e173acaa5c>` | | | the policy-config - the config data provided by policy owner
1058 policyName | Yes | string | | | unique policy name that contains the version and extension
1059 policyVersion | Yes | string | | | stringified int that is autoincremented by policy-engine
1061 .. _i_ba9593ef6832fb8401f266e173acaa5c:
1066 the policy-config - the config data provided by policy owner
1070 .. _d_6ea6e6f48a0302e963a67833bbd0ff4a:
1072 DCAEPolicyRequest Model Structure
1073 ---------------------------------
1075 request to update policies on DCAE components.
1079 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1080 :widths: 20, 10, 15, 15, 30, 25
1082 catch_up | Yes | boolean | | | flag to indicate whether the request contains all the policies in PDP or not
1083 errored_policies | No | :ref:`errored_policies <i_0e88fa72c5312eaae3990753181ce5fe>` | | | whether policy-engine returned an error on the policy.
1084 dictionary of (policy_id -> true).
1085 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
1087 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.
1089 latest_policies | Yes | :ref:`latest_policies <i_cbc40bad95bddbd536eeab0a92f483af>` | | | dictionary of (policy_id -> DCAEPolicy object).
1090 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
1092 removed_policies | Yes | :ref:`removed_policies <i_0ce52a29e44aa0cc7929fe7b555551bc>` | | | whether policy was removed from policy-engine.
1093 dictionary of (policy_id -> true).
1094 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
1096 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.
1099 .. _i_0e88fa72c5312eaae3990753181ce5fe:
1101 **Errored_policies schema:**
1104 whether policy-engine returned an error on the policy.
1105 dictionary of (policy_id -> true).
1106 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
1109 Map of {"key":"boolean"}
1111 .. _i_cbc40bad95bddbd536eeab0a92f483af:
1113 **Latest_policies schema:**
1116 dictionary of (policy_id -> DCAEPolicy object).
1117 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
1120 Map of {"key":":ref:`DCAEPolicy <d_1e3e880a733b457b648bd8c99e6c859c>`"}
1124 .. _i_0ce52a29e44aa0cc7929fe7b555551bc:
1126 **Removed_policies schema:**
1129 whether policy was removed from policy-engine.
1130 dictionary of (policy_id -> true).
1131 In example: replace additionalProp1,2,3 with policy_id1,2,3 values
1134 Map of {"key":"boolean"}