Stack events

This section describes the operations that are supported for stack events.

Find stack events

GET /v1/{tenant_id}/stacks/{stack_name}/events

Finds the canonical URL for the event list of a specified stack.

This table shows the possible response codes for this operation:

Response Code	Name	Description
302	Found	The requested resource resides temporarily under a different URI.

Request

This table shows the URI parameters for the request:

Name	Type	Description
{tenant_id}	String	The ID of the tenant. A tenant is also known as an account or project.
stack_name	String (Required)	The name of a stack.

This operation does not accept a request body.

Response

This operation does not return a response body.

List stack events

GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/events

Lists events for a specified stack.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200	Success	Request succeeded.
400	Bad Request	The request could not be understood by the server due to malformed syntax.
401	Unauthorized	The request requires user authentication.
404	Not Found	The server has not found anything matching the Request-URI.
500	Internal Server Error	The server encountered an unexpected condition which prevented it from fulfilling the request.

Request

This table shows the URI parameters for the request:

Name	Type	Description
{tenant_id}	String	The ID of the tenant. A tenant is also known as an account or project.
stack_name	String (Required)	The name of a stack.
{stack_id}	String (Required)	The stack ID.

This table shows the query parameters for the request:

Name	Type	Description
resource_action	String (Optional)	Filters the event list by a specified resource action. You can use this filter multiple times to filter by multiple resource actions. Valid resource actions are CREATE, DELETE, UPDATE, ROLLBACK, SUSPEND, RESUME, and ADOPT.
resource_status	String (Optional)	Filters the event list by a specified resource status. You can use this filter multiple times to filter by multiple resource statuses. Valid resource statuses are IN_PROGRESS, COMPLETE, and FAILED.
resource_name	String (Optional)	Filters the event list by a specified resource name. You can use this filter multiple times to filter by multiple resource names.
resource_type	String (Optional)	Filters the event list by a specified resource type. You can use this filter multiple times to filter by multiple resource types. Valid resource types include OS::Nova::Server, OS::Cinder::Volume, OS::Neutron::Port, and so on.
limit	Int (Optional)	Requests a specified page size of returned items from the query. Returns a number of items up to the specified limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.
marker	String (Optional)	Specifies the ID of the last-seen item. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.
sort_keys	String (Optional)	Sorts the list by the resource_type or created_at key.
sort_dir	String (Optional)	The sort direction of the list. A valid value is asc (ascending) or desc (descending).

This operation does not accept a request body.

Response

Example List stack events: JSON response

{
    "events": [
        {
            "resource_name": "port",
            "event_time": "2014-07-23T08:14:47Z",
            "links": [{
                "href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5/resources/port/events/474bfdf0-a450-46ec-a78a-0c7faa404073",
                "rel": "self"
            },
            {
                "href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5/resources/port",
                "rel": "resource"
            },
            {
                "href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5",
                "rel": "stack"
            }],
            "logical_resource_id": "port",
            "resource_status": "CREATE_FAILED",
            "resource_status_reason": "NotFound: Subnet f8a699d0-3537-429e-87a5-6b5a8d0c2bf0 could not be found",
            "physical_resource_id": null,
            "id": "474bfdf0-a450-46ec-a78a-0c7faa404073"
        },
        {
            "resource_name": "port",
            "event_time": "2014-07-23T08:14:47Z",
            "links": [{
                "href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5/resources/port/events/66fa95b6-e6f8-4f05-b1af-e828f5aba04c",
                "rel": "self"
            },
            {
                "href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5/resources/port",
                "rel": "resource"
            },
            {
                "href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5",
                "rel": "stack"
            }],
            "logical_resource_id": "port",
            "resource_status": "CREATE_IN_PROGRESS",
            "resource_status_reason": "state changed",
            "physical_resource_id": null,
            "id": "66fa95b6-e6f8-4f05-b1af-e828f5aba04c"
        }
    ]
}

List resource events

GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/events

Lists events for a specified stack resource.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200	Success	Request succeeded.
400	Bad Request	The request could not be understood by the server due to malformed syntax.
401	Unauthorized	The request requires user authentication.
404	Not Found	The server has not found anything matching the Request-URI.

Request

This table shows the URI parameters for the request:

Name	Type	Description
{tenant_id}	String	The ID of the tenant. A tenant is also known as an account or project.
stack_name	String (Required)	The name of a stack.
{stack_id}	String (Required)	The stack ID.
{resource_name}	String (Required)	The name of a resource in the stack.

This table shows the query parameters for the request:

Name	Type	Description
resource_action	String (Optional)	Filters the event list by a specified resource action. You can use this filter multiple times to filter by multiple resource actions. Valid resource actions are CREATE, DELETE, UPDATE, ROLLBACK, SUSPEND, RESUME, and ADOPT.
resource_status	String (Optional)	Filters the event list by a specified resource status. You can use this filter multiple times to filter by multiple resource statuses. Valid resource statuses are IN_PROGRESS, COMPLETE, and FAILED.
resource_name	String (Optional)	Filters the event list by a specified resource name. You can use this filter multiple times to filter by multiple resource names.
resource_type	String (Optional)	Filters the event list by a specified resource type. You can use this filter multiple times to filter by multiple resource types. Valid resource types include OS::Nova::Server, OS::Cinder::Volume, OS::Neutron::Port, and so on.
limit	Int (Optional)	Requests a specified page size of returned items from the query. Returns a number of items up to the specified limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.
marker	String (Optional)	Specifies the ID of the last-seen item. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.
sort_keys	String (Optional)	Sorts the list by the resource_type or created_at key.
sort_dir	String (Optional)	The sort direction of the list. A valid value is asc (ascending) or desc (descending).

This operation does not accept a request body.

Response

Example List resource events: JSON response

{
    "events": [
        {
            "resource_name": "port",
            "event_time": "2014-07-23T08:14:47Z",
            "links": [{
                "href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5/resources/port/events/474bfdf0-a450-46ec-a78a-0c7faa404073",
                "rel": "self"
            },
            {
                "href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5/resources/port",
                "rel": "resource"
            },
            {
                "href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5",
                "rel": "stack"
            }],
            "logical_resource_id": "port",
            "resource_status": "CREATE_FAILED",
            "resource_status_reason": "NotFound: Subnet f8a699d0-3537-429e-87a5-6b5a8d0c2bf0 could not be found",
            "physical_resource_id": null,
            "id": "474bfdf0-a450-46ec-a78a-0c7faa404073"
        },
        {
            "resource_name": "port",
            "event_time": "2014-07-23T08:14:47Z",
            "links": [{
                "href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5/resources/port/events/66fa95b6-e6f8-4f05-b1af-e828f5aba04c",
                "rel": "self"
            },
            {
                "href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5/resources/port",
                "rel": "resource"
            },
            {
                "href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5",
                "rel": "stack"
            }],
            "logical_resource_id": "port",
            "resource_status": "CREATE_IN_PROGRESS",
            "resource_status_reason": "state changed",
            "physical_resource_id": null,
            "id": "66fa95b6-e6f8-4f05-b1af-e828f5aba04c"
        }
    ]
}

Show event details

GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/events/{event_id}

Shows details for a specified event.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200	Success	Request succeeded.

Request

This table shows the URI parameters for the request:

Name	Type	Description
{tenant_id}	String	The ID of the tenant. A tenant is also known as an account or project.
stack_name	String (Required)	The name of a stack.
{stack_id}	String (Required)	The stack ID.
{resource_name}	String (Required)	The name of a resource in the stack.
{event_id}	String (Required)	The ID of an event related to the resource in the stack.

This operation does not accept a request body.

Response

Example Show event details: JSON response

{
    "event": {
        "event_time": "2015-06-25T14:59:53",
        "id": "8db23e2e-72b2-47a2-9ed9-b52417f56e50",
        "links": [
            {
                "href": "http://hostname/v1/1234/stacks/mystack/56789/resources/random_key_name/events/8db23e2e-72b2-47a2-9ed9-b52417f56e50",
                "rel": "self"
            },
            {
                "href": "http://hostname/v1/1234/stacks/mystack/56789/resources/random_key_name",
                "rel": "resource"
            },
            {
                "href": "http://hostname/v1/1234/stacks/mystack/56789",
                "rel": "stack"
            }
        ],
        "logical_resource_id": "random_key_name",
        "physical_resource_id": null,
        "resource_name": "random_key_name",
        "resource_properties": {
            "character_classes": null,
            "character_sequences": null,
            "length": 8,
            "salt": null,
            "sequence": null
        },
        "resource_status": "CREATE_IN_PROGRESS",
        "resource_status_reason": "state changed",
        "resource_type": "OS::Heat::RandomString"
    }
}