ListContainerImages
GET {{baseUrl}}/container/images?compartmentIdInSubtree=true&compartmentId={{tenancy_ocid}}&limit=791&sortBy=TIMECREATED&sortOrder=DESC
List container images in a compartment.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
compartmentIdInSubtree | boolean | When set to true, the hierarchy of compartments is traversed | |
and all compartments and subcompartments in the tenancy are | |||
inspected depending on the the setting of accessLevel . | |||
Default is false. Can only be set to true when calling the API | |||
on the tenancy (root compartment). | |||
compartmentId | string | (Required) The OCID of the compartment. | |
displayName | string | A filter to return only resources that match the given display name exactly. | |
imageId | string | A filter to return a container image summary only for the specified container image OCID. | |
isVersioned | boolean | A filter to return container images based on whether there are any associated versions. | |
repositoryId | string | A filter to return container images only for the specified container repository OCID. | |
repositoryName | string | A filter to return container images or container image signatures that match the repository name. |
Example: foo
or foo*
|
| version
| string | | A filter to return container images that match the version.
Example: foo
or foo*
|
| lifecycleState
| string | | A filter to return only resources that match the given lifecycle state name exactly.
|
| limit
| number | | For list pagination. The maximum number of results per page, or items to return in a paginated
"List" call. For important details about how pagination works, see
List Pagination.
Example: 50
|
| page
| string | | For list pagination. The value of the opc-next-page
response header from the previous "List"
call. For important details about how pagination works, see
List Pagination.
|
| sortBy
| string | | The field to sort by. You can provide one sort order (sortOrder
). Default order for
TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
sort order is case sensitive.
Note: In general, some "List" operations (for example, ListInstances
) let you
optionally filter by availability domain if the scope of the resource type is within a
single availability domain. If you call one of these "List" operations without specifying
an availability domain, the resources are grouped by availability domain, then sorted.
|
| sortOrder
| string | | The sort order to use, either ascending (ASC
) or descending (DESC
). The DISPLAYNAME sort order
is case sensitive.
|
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
opc-request-id | string | Unique 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
{"items":[{"compartmentId":"laborum et","digest":"culpa fugiat adipisicing","displayName":"voluptate","id":"deserunt eiusmod dolor","lifecycleState":"magna","repositoryId":"aliqua Duis","repositoryName":"veniam eu anim amet","timeCreated":"1955-08-17T00:44:48.390Z","version":"in tempor dolore"},{"compartmentId":"id deserunt magna occaecat in","digest":"ex anim quis","displayName":"deserunt","id":"ut amet officia laborum","lifecycleState":"amet adipisicing nisi","repositoryId":"et tempor dolore mollit qui","repositoryName":"reprehenderit consequat","timeCreated":"2015-09-15T23:18:06.287Z","version":"aliquip"}],"remainingItemsCount":26212542}