• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Heat
  5. Stack Event Management
  6. Querying Events of a Stack

Querying Events of a Stack

Function

This API is used to query events of a stack.

URI

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

NOTE:

This API supports redirection. During the calling, you can specify only stack_name or stack_id.

For details about the parameters, see Table 1.

Table 1 Parameter description

Parameter

Type

Mandatory

Description

project_id

String

Yes

Specifies the project ID.

stack_name

String

Yes

Specifies the stack name.

stack_id

String

Yes

Specifies the stack UUID.

Request Parameter

N/A

Response Parameter

Parameter

In

Type

Description

events

body

List <dict>

Specifies the events of a resource.

events structure information

Parameter

In

Type

Description

resource_name

body

String

Specifies the resource name.

event_time

body

String

Specifies the time when an event occurs.

links

body

List <dict>

Specifies the event URL list.

logical_resource_id

body

String

Specifies the logical resource ID.

resource_status_reason

body

String

Specifies the resource operation reason.

resource_status

body

String

Specifies the resource status.

physical_resource_id

body

String

Specifies the physical resource ID.

id

body

String

Specifies the event ID.

Request Example

GET /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/events

Response Example

{
    "events": [
        {
            "resource_name": "instacne_port",
            "event_time": "2014-01-26T17:21:35Z",
            "links": [
                {
                     "href":  "http://x.x.x.x:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/resources/instacne_port/events/1302",
                     "rel": "self"
                },
                {
                     "href":  "http://x.x.x.x:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/resources/instacne_port",
                     "rel": "resource"
                 },
                 {
                     "href":  "http://x.x.x.x:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306",
                     "rel": "stack"
                 }
            ],
            "logical_resource_id": "instacne_port",
            "resource_status_reason": "state changed",
            "resource_status": "CREATE_IN_PROGRESS",
            "physical_resource_id": null,
            "id": "1302"
        }
    ]
}

Return Code

Table 2 Normal return code

Return Code

Type

Description

200

OK

Request was successful.

302

Found

The response is about redirection. The response header usually contains a location value that allows you to track the real location of the resource.

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.