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"
],
"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"
}integer As int32 As int32
cpuShares
Optional
cpuShares
array of string
volumesFrom
Optional
volumesFrom
integer As int64 As int64
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 int64 As int64
memoryLimit
Optional
memoryLimit
array of string
tenantLinks
Optional
tenantLinks
array of string
entryPoint
Optional
entryPoint
array of string
device
Optional
device
string
desc
Optional
desc
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 string
extraHosts
Optional
extraHosts
array of string
tagLinks
Optional
tagLinks
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
string
regionId
Optional
regionId
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
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
PUT
Update PKS Endpoint Spec