• Native OpenStack API

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

Update Deployment

Function Description

This interface is used to update the deployment resource.

Interface Format

Method

URI

Description

PUT

/v1/{tenant_id}/software_deployments/{deployment_id}

Update the deployment resource.

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.

output_values

Object

Yes

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

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": "COMPLETE",
    "output_values": {
        "deploy_stdout": "Writing to /tmp/baaaaa\nWritten to /tmp/baaaaa\n",
        "deploy_stderr": "+ echo Writing to /tmp/baaaaa\n+ echo fooooo\n+ cat /tmp/baaaaa\n+ echo -n The file /tmp/baaaaa contains fooooo for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE\n+ echo Written to /tmp/baaaaa\n+ echo Output to stderr\nOutput to stderr\n",
        "deploy_status_code": 0,
        "result": "The file /tmp/baaaaa contains fooooo for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE"
    },
    "status_reason": "Outputs received"
}

Response Example

{
    "software_deployment": {
        "status": "COMPLETE",
        "server_id": "ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5",
        "config_id": "3d5ec2a8-7004-43b6-a7f6-542bdbe9d434",
        "output_values": {
            "deploy_stdout": "Writing to /tmp/baaaaa\nWritten to /tmp/baaaaa\n",
            "deploy_stderr": "+ echo Writing to /tmp/baaaaa\n+ echo fooooo\n+ cat /tmp/baaaaa\n+ echo -n The file /tmp/baaaaa contains fooooo for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE\n+ echo Written to /tmp/baaaaa\n+ echo Output to stderr\nOutput to stderr\n",
            "deploy_status_code": 0,
            "result": "The file /tmp/baaaaa contains fooooo for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE"
        },
        "input_values": null,
        "action": "CREATE",
        "status_reason": "Outputs received",
        "id": "06e87bcc-33a2-4bce-aebd-533e698282d3",
        "creation_time": "2015-01-31T15:12:36Z",
        "updated_time": "2015-01-31T15:18:21Z"
    }
}

Returned Code

For details, see section Return Code Processing.