Get Container Description

Get Container Description

Only Solution users, Container admins, and System admins can retrieve ContainerDescriptions.

Request
URI
GET
https://{api_host}/container-service/api/resources/container-descriptions/{id}
COPY
Path Parameters
string
id
Required

The id of the ContainerDescription

Responses
200

OK with the ContainerDescription

Returns ContainerDescription of type(s) */* 
{
    "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"
    ],
    "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"
    },
    "dnsSearch": [
        "string"
    ],
    "publishAll": false,
    "user": "string"
}
integer As int32 As int32
cpuShares
Optional

cpuShares

array of string
volumesFrom
Optional

volumesFrom

integer As int32 As int32
memorySwapLimit
Optional

memorySwapLimit

string
deploymentPolicyId
Optional

deploymentPolicyId

string
hostname
Optional

hostname

array of string
capAdd
Optional

capAdd

string
zoneId
Optional

zoneId

array of string
groupLinks
Optional

groupLinks

array of string
links
Optional

links

string
id
Optional

id

string
parentDescriptionLink
Optional

parentDescriptionLink

string
networkMode
Optional

networkMode

string
image
Optional

image

array of string
dependsOn
Optional

dependsOn

string
workingDir
Optional

workingDir

array of string
dns
Optional

dns

array of string
volumes
Optional

volumes

boolean
privileged
Optional

privileged

integer As int32 As int32
_cluster
Optional

_cluster

object
customProperties
Optional

customProperties

string
documentSelfLink
Optional

documentSelfLink

string
domainName
Optional

domainName

string
name
Optional

name

array of string
capDrop
Optional

capDrop

integer As int32 As int32
memoryLimit
Optional

memoryLimit

array of string
tenantLinks
Optional

tenantLinks

array of string
entryPoint
Optional

entryPoint

array of string
device
Optional

device

array of string
affinity
Optional

affinity

integer As int32 As int32
maximumRetryCount
Optional

maximumRetryCount

string
pidMode
Optional

pidMode

string
pod
Optional

pod

object
networks
Optional

networks

string As uri As uri
instanceAdapterReference
Optional

instanceAdapterReference

array of PortBinding
portBindings
Optional

portBindings

array of string
extraHosts
Optional

extraHosts

array of string
tagLinks
Optional

tagLinks

LogConfig
logConfig
Optional

logConfig

string
documentExpirationTimeMicros
Optional

documentExpirationTimeMicros

string
volumeDriver
Optional

volumeDriver

string As uri As uri
imageReference
Optional

imageReference

array of string
env
Optional

env

string
restartPolicy
Optional

restartPolicy

array of string
command
Optional

command

string
documentUpdateTimeMicros
Optional

documentUpdateTimeMicros

HealthConfig
healthConfig
Optional

healthConfig

array of string
dnsSearch
Optional

dnsSearch

boolean
publishAll
Optional

publishAll

string
user
Optional

user


404

'Not Found' if no ContainerDescription with provided id

Operation doesn't return any data structure

On This Page
Get Operations
GET
Adapter Get
GET
Get Auth Credentials Service State
GET
Get Catalog Resource Item
GET
Get Catalog Resource Item
GET
Get Catalog Resource Item
GET
Get Closure Description
GET
Get Closure State
GET
Get Composite Component
GET
Get Composite Description
GET
Get Compute Description
GET
Get Compute Network
GET
Get Compute Network Description
GET
Get Compute Profile
GET
Get Compute State
GET
Get Configuration State
GET
Get Container Description
GET
Get Container Network Description
GET
Get Container Network State
GET
Get Container Request Status
GET
Get Container State
GET
Get Container Stats
GET
Get Container Volume Description
GET
Get Container Volume State
GET
Get Deployment Policy
GET
Get Elastic Placement Zone Configuration State
GET
Get Elastic Placement Zone State
GET
Get Endpoint State
GET
Get Endpoint State
GET
Get Event Log State
GET
Get Group Resource Placement State
GET
Get Image Enumeration Task State
GET
Get Image State
GET
Get Log Service State
GET
Get Network Interface Description
GET
Get Network Interface State
GET
Get Network Profile
GET
Get Network State
GET
Get Notifications
GET
Get Photon Model Adapter Config
GET
Get Profile State
GET
Get Registry State
GET
Get Request Broker State
GET
Get Resource Group State
GET
Get Resource Pool State
GET
Get Service Document Delete Task State
GET
Get Ssl Trust Certificate State
GET
Get Ssl Trusted Certificate State
GET
Get Storage Profile
GET
Get Subnet State
GET
Get Tag State
GET
Group Tenant Controller.get
POST
Run Closure