Returns a stack or list of stacks.
GET {{baseUrl}}/stacks?compartmentId={{compartment_ocid}}&sortBy=TIMECREATED&sortOrder=DESC&limit=328&page=
Returns a list of stacks. - If called using the compartment ID, returns all stacks in the specified compartment. - If called using the stack ID, returns the specified stack.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
compartmentId | string | A filter to return only resources that exist in the compartment, identified by OCID. | |
id | string | The OCID on which to query for a stack. | |
lifecycleState | string | A filter that returns only those resources that match the specified | |
lifecycle state. The state value is case-insensitive. | |||
For more information about stack lifecycle states, see | |||
Key Concepts. |
Allowable values:
- CREATING
- ACTIVE
- DELETING
- DELETED
- FAILED
|
|
displayName
| string | | A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. RequiressortBy
set toDISPLAYNAME
. Alternatively, when you know the resource OCID, use the related Get operation. | |sortBy
| string | | The field to use when sorting returned resources. By default,TIMECREATED
is ordered descending. By default,DISPLAYNAME
is ordered ascending. Note that you can sort only on one field. | |sortOrder
| string | | The sort order to use when sorting returned resources. Ascending (ASC
) or descending (DESC
). | |limit
| number | | The number of items returned in a paginatedList
call. For information about pagination, see List Pagination. | |page
| null | | The value of theopc-next-page
response header from the precedingList
call. For information about pagination, see List Pagination. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
opc-request-id | string | Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a | |
particular request, please provide the request ID. | |||
Date | string | (Required) Current Date | |
Authorization | string | (Required) Signature Authentication on Authorization header |
RESPONSES
status: OK
[{"compartmentId":"consectetur nulla ","definedTags":{},"description":"reprehenderit eiusmod nisi officia","displayName":"ex incididunt","freeformTags":{},"id":"Lorem est ullamco sed laboris","lifecycleState":"adipisicing eiusmod","terraformVersion":"dolore incididunt","timeCreated":"1951-09-25T12:15:39.327Z"},{"compartmentId":"velit consequat et","definedTags":{},"description":"Ut aliquip dolor","displayName":"eiusmod voluptate et","freeformTags":{},"id":"sed est","lifecycleState":"eiusmod adipisicing sit minim","terraformVersion":"tempor","timeCreated":"1970-07-25T21:44:06.824Z"}]