• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Heat
  5. Stacks
  6. List Stacks

List Stacks

Function Description

This interface is used to query the stack list of a specified tenant.

Interface Format

Method

URI

Description

GET

/v1/{tenant_id}/stacks

Queries all stacks accessible to the tenant submitting the request.

Request Parameter

Parameter

Type

Mandatory

Description

status

String

No

Specifies the stack status.

name

String

No

Specifies the stack name. The value must meet the regular expression rule (^[a-zA-Z][a-zA-Z0-9_.-]{0,254}$).

limit

String

No

Specifies the paging information.

marker

String

No

Specifies the paging information.

sort_keys

String

No

Specifies the sorting key.

The value can be namestatuscreated_at, or updated_at.

sort_dir

String

No

Specifies the sorting order. The value can be asc (ascending) or desc (descending).

Response Parameter

Parameter

Type

Mandatory

Description

stacks

List

Yes

Specifies the stack list.

Stack structure

Parameter

Type

Mandatory

Description

id

Uuid-String

Yes

Specifies the stack UUID.

stack_name

List(dict)

Yes

Specifies the stack name.

stack_status

String

Yes

Specifies the stack status.

stack_status_reason

String

Yes

Specifies the description of the stack operation.

description

String

Yes

Describes the stack.

links

String

Yes

Specifies the stack URI.

creation_time

String

Yes

Specifies the time when a stack was created.

updated_time

String

Yes

Specifies the time when a stack was updated.

Request Example

GET /v1/95d02433133a4c0a87ba6967474a2ad3/stacks

Response Example

{"stacks": [{
   "description": "Hello world HOT template that just defines a single compute instance. Contains just base features to verify base HOT support.\n",
   "links": [   {
      "href": "http://172.25.150.29:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306",
      "rel": "self"
   }],
   "stack_status_reason": "Stack create completed successfully",
   "stack_name": "HeatStack",
   "creation_time": "2014-01-26T17:21:35Z",
   "updated_time": "2014-01-26T17:21:41Z",
   "stack_status": "CREATE_COMPLETE",
   "id": "c89c4bb3-96cb-4a55-aafa-076a7939a306"
}]}

Returned Code

See Return Code Processing.