• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Heat
  5. Software Configuration
  6. Create Deployment

Create Deployment

Function Description

This interface is used to create deployment resources.

Interface Format

Method

URI

Description

POST

/v1/{tenant_id}/software_deployments

Create deployment resources.

Request Parameter

Parameter

Type

Mandatory

Description

action

String

No

Specifies the stack action that triggers this deployment resource.

config_id

String

Yes

Specifies the ID of the software configuration resource running on an instance.

input_values

Object

No

Specifies input data stored in the form of a key-value pair.

server_id

String

Yes

Specifies the ID of the instance deployed by the software configuration.

stack_user_project_id

String

No

Specifies the ID of the authenticated tenant who can perform operations on the deployment resources.

status

String

No

Specifies the current status of deployment resources. Valid values include COMPLETEIN_PROGRESS, and FAILED.

status_reason

String

No

Specifies the cause of the current deployment resource status.

Response Parameter

Parameter

Type

Mandatory

Description

action

String

No

Specifies the stack action that triggers this deployment resource.

config_id

String

Yes

Specifies the ID of the software configuration resource running on an instance.

creation_time

String

Yes

Specifies the creation time. The timestamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm.

id

String

Yes

Specifies the ID of this deployment resource.

input_values

Object

No

Specifies input data stored in the form of a key-value pair.

output_values

Object

Yes

Specifies output data stored in the form of a key-value pair.

server_id

String

Yes

Specifies the instance ID.

software_deployment

String

Yes

Specifies a deployment resource object.

status

String

No

Specifies the current status of deployment resources. Valid values include COMPLETEIN_PROGRESS, and FAILED.

status_reason

String

No

Specifies the cause of the current deployment resource status.

updated_time

String

No

Specifies the update time. The timestamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm.

Request Example

{
    "status": "IN_PROGRESS",
    "server_id": "ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5",
    "config_id": "8da95794-2ad9-4979-8ae5-739ce314c5cd",
    "stack_user_project_id": "c024bfada67845ddb17d2b0c0be8cd79",
    "action": "CREATE",
    "status_reason": "Deploy data available"
}

Response Example

{
    "software_deployment": {
        "status": "IN_PROGRESS",
        "server_id": "ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5",
        "config_id": "8da95794-2ad9-4979-8ae5-739ce314c5cd",
        "output_values": null,
        "input_values": null,
        "action": "CREATE",
        "status_reason": "Deploy data available",
        "id": "ef422fa5-719a-419e-a10c-72e3a367b0b8",
        "creation_time": "2015-01-31T15:12:36Z",
        "updated_time": "2015-01-31T15:18:21Z"
    }
}

Returned Code

For details, see section Return Code Processing.