Get Container State

Get Container State

Retrieves a ContainerState.

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

id

Responses
200

OK with the ContainerState

Returns ContainerState of type(s) */* 
{
    "cpuShares": 0,
    "volumesFrom": [
        "string"
    ],
    "ports": [
        {
            "protocol": "string",
            "hostIp": "string",
            "containerPort": "string",
            "hostPort": "string"
        }
    ],
    "compositeComponentLink": "string",
    "hostReference": "string",
    "powerState": "string",
    "isDeleted": false,
    "groupResourcePlacementLink": "string",
    "extraHosts": [
        "string"
    ],
    "tagLinks": [
        "string"
    ],
    "groupLinks": [
        "string"
    ],
    "links": [
        "string"
    ],
    "id": "string",
    "image": "string",
    "documentExpirationTimeMicros": "string",
    "parentLink": "string",
    "address": "string",
    "created": 0,
    "volumeDriver": "string",
    "volumes": [
        "string"
    ],
    "descriptionLink": "string",
    "started": 0,
    "env": [
        "string"
    ],
    "storageLimit": 0,
    "command": [
        "string"
    ],
    "documentUpdateTimeMicros": "string",
    "names": [
        "string"
    ],
    "system": false,
    "adapterManagementReference": "string",
    "regionId": "string",
    "documentSelfLink": "string",
    "name": "string",
    "memoryLimit": 0,
    "tenantLinks": [
        "string"
    ],
    "desc": "string",
    "status": "string"
}
integer As int32 As int32
cpuShares
Optional

cpuShares

array of string
volumesFrom
Optional

volumesFrom

array of PortBinding
ports
Optional

ports

object
networks
Optional

networks

string
compositeComponentLink
Optional

compositeComponentLink

string
hostReference
Optional

hostReference

string
powerState
Optional

powerState

Possible values are : UNKNOWN, PROVISIONING, RUNNING, PAUSED, STOPPED, RETIRED, ERROR,
boolean
isDeleted
Optional

isDeleted

string
groupResourcePlacementLink
Optional

groupResourcePlacementLink

array of string
extraHosts
Optional

extraHosts

array of string
tagLinks
Optional

tagLinks

array of string
groupLinks
Optional

groupLinks

array of string
links
Optional

links

string
id
Optional

id

string
image
Optional

image

string
documentExpirationTimeMicros
Optional

documentExpirationTimeMicros

string
parentLink
Optional

parentLink

string
address
Optional

address

integer As int64 As int64
created
Optional

created

string
volumeDriver
Optional

volumeDriver

array of string
volumes
Optional

volumes

string
descriptionLink
Optional

descriptionLink

integer As int64 As int64
started
Optional

started

array of string
env
Optional

env

integer As int64 As int64
storageLimit
Optional

storageLimit

array of string
command
Optional

command

string
documentUpdateTimeMicros
Optional

documentUpdateTimeMicros

object
customProperties
Optional

customProperties

array of string
names
Optional

names

boolean
system
Optional

system

string
adapterManagementReference
Optional

adapterManagementReference

string
regionId
Optional

regionId

string
documentSelfLink
Optional

documentSelfLink

string
name
Optional

name

integer As int64 As int64
memoryLimit
Optional

memoryLimit

object
attributes
Optional

attributes

array of string
tenantLinks
Optional

tenantLinks

string
desc
Optional

desc

string
status
Optional

status


404

'Not Found' if no ContainerState with provided id

Operation doesn't return any data structure

On This Page
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