Deployments
Contents
Deployment
Show deployment
GET /v3/plugins/tosca/deployments/:id
It shows information about a specific deployment.
Inputs
None
Returns
| Field | Type | Description |
|---|---|---|
| cat_id | String | Identifier of the cat. |
| resource_type | String | An identifier for the type of resource, specifically "deployment". |
Destroy deployment
DELETE /v3/plugins/tosca/deployments/:id
It destroys a deployment.
Inputs
None
Returns
| Field | Type | Description |
|---|---|---|
| cat_id | String | Identifier of the cat. |
| resource_type | String | An identifier for the type of resource, specifically "deployment". |
Deployment Tasks
Show deployment task
GET /v3/plugins/tosca/cats/:cat_id/deployment_tasks/:id
It shows information about a specific deployment task.
Inputs
None
Returns
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the deployment task. |
| type | String | The type of deployment. Can be either ‘import' or ‘export'. |
| label_name | String | The label name of the deployment. |
| label_id | String | The label id of the deployment. |
| state | String | The state of the deployment task. |
| error_message | String | It indicates the error that happened when the deployment task failed. |
| outputs | String | Outputs of the deployment once if finished successfully. |
| user_id | String | Identifier of the user that creates the deployment |
| archive_id | String | Identifier of the cat |
| deployment_id | String | Identifier of the deployment of the cat |
| resource_type | String | An identifier for the type of resource, specifically "deployment". |
Create deployment task
POST /v3/plugins/tosca/cats/:cat_id/deployment_tasks
It creates a deployment tasks that can either be an import or an export of a CAT.
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| label_name | String | The label that will be used by the infrastructure when it would be created. | Yes |
| default_realm_provider_name | String | Name of the realm where the operation will be done. | Yes |
| default_cloud_provider_name | String | Name of the cloud provider where the operation will be done. | Yes |
| inputs | Array of String | An array of strings with the input values needed for the operation. | No |
Returns
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the deployment task. |
| type | String | The type of deployment. Can be either ‘import' or ‘export'. |
| label_name | String | The label name of the deployment. |
| label_id | String | The label id of the deployment. |
| state | String | The state of the deployment task. |
| error_message | String | It indicates the error that happened when the deployment task failed. |
| outputs | String | Outputs of the deployment once if finished successfully. |
| user_id | String | Identifier of the user that creates the deployment |
| archive_id | String | Identifier of the cat |
| deployment_id | String | Identifier of the deployment of the cat |
| resource_type | String | An identifier for the type of resource, specifically "deployment". |
Destroy deployment task
DELETE /v3/plugins/tosca/cats/:cat_id/deployment_tasks/:id
It destroys a deployment task.
Inputs
None
Returns
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the deployment task. |
| type | String | The type of deployment. Can be either ‘import' or ‘export'. |
| label_name | String | The label name of the deployment. |
| label_id | String | The label id of the deployment. |
| state | String | The state of the deployment task. |
| error_message | String | It indicates the error that happened when the deployment task failed. |
| outputs | String | Outputs of the deployment once if finished successfully. |
| user_id | String | Identifier of the user that creates the deployment |
| archive_id | String | Identifier of the cat |
| deployment_id | String | Identifier of the deployment of the cat |
| resource_type | String | An identifier for the type of resource, specifically "deployment". |