List Container Description
Only Solution users, Container admins, and System admins can list ContainerDescriptions.
Request
URI
GET
https://{api_host}/container-service/api/resources/container-descriptions
COPY
Query Parameters
integer
page
Optional
Page Number
integer
limit
Optional
Number of entries per page
string
$orderby
Optional
Multiple comma-separated properties sorted in ascending or descending order
integer
$top
Optional
Sets the number of returned entries from the top of the response (total number per page in relation to skip)
integer
$skip
Optional
Sets how many entries you would like to skip
string
$filter
Optional
Boolean expression for whether a particular entry should be included in the response
Responses
200
successful operation
Returns PageContainerDescription of type(s) */*
{
"number": 0,
"numberOfElements": 0,
"last": false,
"size": 0,
"totalPages": 0,
"first": false,
"content": [
{
"cpuShares": 0,
"volumesFrom": [
"string"
],
"memorySwapLimit": 0,
"deploymentPolicyId": "string",
"hostname": "string",
"capAdd": [
"string"
],
"zoneId": "string",
"groupLinks": [
"string"
],
"links": [
"string"
],
"id": "string",
"parentDescriptionLink": "string",
"networkMode": "string",
"image": "string",
"dependsOn": [
"string"
],
"workingDir": "string",
"dns": [
"string"
],
"volumes": [
"string"
],
"privileged": false,
"_cluster": 0,
"documentSelfLink": "string",
"domainName": "string",
"name": "string",
"capDrop": [
"string"
],
"memoryLimit": 0,
"tenantLinks": [
"string"
],
"entryPoint": [
"string"
],
"device": [
"string"
],
"desc": "string",
"affinity": [
"string"
],
"maximumRetryCount": 0,
"pidMode": "string",
"pod": "string",
"instanceAdapterReference": "string",
"portBindings": [
{
"protocol": "string",
"hostIp": "string",
"containerPort": "string",
"hostPort": "string"
}
],
"extraHosts": [
"string"
],
"tagLinks": [
"string"
],
"logConfig": {
"type": "string"
},
"documentExpirationTimeMicros": "string",
"volumeDriver": "string",
"imageReference": "string",
"env": [
"string"
],
"restartPolicy": "string",
"command": [
"string"
],
"documentUpdateTimeMicros": "string",
"healthConfig": {
"ignoreOnProvision": false,
"protocol": "string",
"httpVersion": "string",
"port": 0,
"autoredeploy": false,
"unhealthyThreshold": 0,
"timeoutMillis": 0,
"healthyThreshold": 0,
"httpMethod": "string",
"urlPath": "string",
"command": "string"
},
"regionId": "string",
"dnsSearch": [
"string"
],
"publishAll": false,
"user": "string"
}
],
"totalElements": 0
}
integer As int32 As int32
number
Optional
number
integer As int32 As int32
numberOfElements
Optional
numberOfElements
boolean
last
Optional
last
integer As int32 As int32
size
Optional
size
integer As int32 As int32
totalPages
Optional
totalPages
boolean
first
Optional
first
integer As int64 As int64
totalElements
Optional
totalElements
Container Operations
POST
Create Container Description
POST
Create Container Network Description
POST
Create Container Network State
POST
Create Container State
POST
Create Container Type
POST
Create Container Volume Description
POST
Create Container Volume State
PUT
Create Or Update Container Type
DELETE
Delete Container Description
DELETE
Delete Container Network Description
DELETE
Delete Container Network State
DELETE
Delete Container State
DELETE
Delete Container Type
DELETE
Delete Container Volume Description
DELETE
Delete Container Volume State
GET
Get Catalog Resource Item
GET
Get Catalog Resource Item
GET
Get Catalog Resource Item
GET
Get Container Description
GET
Get Container Network Description
GET
Get Container Network State
GET
Get Container State
GET
Get Container Stats
GET
Get Container Stats
GET
Get Container Type
GET
Get Container Volume Description
GET
Get Container Volume State
GET
List Container Description
GET
List Container Network Description
GET
List Container Network State
GET
List Container State
GET
List Container Types
GET
List Container Volume Description
GET
List Container Volume State
PATCH
Patch Container Description
PATCH
Patch Container Network Description
PATCH
Patch Container Network State
PATCH
Patch Container State
PATCH
Patch Container Volume Description
PATCH
Patch Container Volume State
POST
Publishes A container description To catalog.
PUT
Update Container Description
PUT
Update Container Host Spec
PUT
Update Container Network Description
PUT
Update Container Network State
PUT
Update Container State
PUT
Update Container Volume Description
PUT
Update Container Volume State