• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Heat
  5. Software Configuration Management
  6. Creating One or More Software Configurations

Creating One or More Software Configurations

Function

This API is used to create one or more software configurations.

URI

POST /v1/{project_id}/software_configs

For details about the parameters, see Table 1.

Table 1 Parameter description

Parameter

Type

Mandatory

Description

project_id

String

Yes

Specifies the project ID.

Request Parameter

Parameter

In

Type

Mandatory

Description

name

body

String

No

Specifies the name of the software configuration.

config

body

String

No

Specifies the script used for defining the configuration.

group

body

String

No

Specifies the name of the software configuration group.

inputs

body

List <dict>

No

Specifies the software configuration input.

outputs

body

List <dict>

No

Specifies the software configuration output.

options

body

String

No

Specifies options used by a software configuration management tool.

Response Parameter

Parameter

In

Type

Description

software_config

body

Dict

Specifies the software configuration information.

software_config structure information

Parameter

In

Type

Description

inputs

body

List <dict>

Specifies the software configuration input.

name

body

String

Specifies the name of the software configuration.

outputs

body

List <dict>

Specifies the software configuration output.

creation_time

body

Date Time

Specifies the time when the configuration is created.

group

body

String

Specifies the name of the software configuration group.

config

body

String

Specifies the software configuration code.

options

body

String

Specifies the software configuration options.

id

body

String

Specifies the software configuration UUID.

Request Example

POST /v1/95d02433133a4c0a87ba6967474a2ad3/software_configs
{
    "inputs": [
        {
            "default": null,
            "type": "String",
            "name": "foo",
            "description": null
        },
        {
            "default": null,
            "type": "String",
            "name": "bar",
            "description": null
        }
    ],
    "group": "script",
    "name": "a-config-we5zpvyu7b5o",
    "outputs": [
        {
            "type": "String",
            "name": "result",
            "error_output": false,
            "description": null
        }
    ],
    "config": "#!/bin/sh -x\necho \"Writing to /tmp/$bar\"\necho $foo > /tmp/$bar\necho -n \"The file /tmp/$bar contains `cat /tmp/$bar` for server $deploy_server_id during $deploy_action\" > $heat_outputs_path.result\necho \"Written to /tmp/$bar\"\necho \"Output to stderr\" 1>&2",
    "options": null
}

Response Example

{
    "software_config": {
        "creation_time": "2015-01-31T15:12:36Z",
        "inputs": [
            {
                "default": null,
                "type": "String",
                "name": "foo",
                "description": null
            },
            {
                "default": null,
                "type": "String",
                "name": "bar",
                "description": null
            }
        ],
        "group": "script",
        "name": "a-config-we5zpvyu7b5o",
        "outputs": [
            {
                "type": "String",
                "name": "result",
                "error_output": false,
                "description": null
            }
        ],
        "options": null,
        "config": "#!/bin/sh -x\necho \"Writing to /tmp/$bar\"\necho $foo > /tmp/$bar\necho -n \"The file /tmp/$bar contains `cat /tmp/$bar` for server $deploy_server_id during $deploy_action\" > $heat_outputs_path.result\necho \"Written to /tmp/$bar\"\necho \"Output to stderr\" 1>&2",
        "id": "ddee7aca-aa32-4335-8265-d436b20db4f1"
    }
}

Return Code

Table 2 Normal return code

Return Code

Type

Description

200

OK

Request was successful.

Table 3 Error return code

Return Code

Type

Description

400

Bad Request

The server failed to process the request.

401

Unauthorized

Authorization failed.

404

Not found

The requested resources are not found.