Get Compute State

Get Compute State

Solution users, System admins, Container admins, and Container architects can retrieve ComputeStates.

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

The id of the ComputeState

Responses
200

OK with the ComputeState

Returns ComputeState of type(s) */* 
{
    "hostName": "string",
    "type": "string",
    "powerState": "string",
    "environmentName": "string",
    "tagLinks": [
        "string"
    ],
    "creationTimeMicros": 0,
    "zoneId": "string",
    "groupLinks": [
        "string"
    ],
    "id": "string",
    "gpuCount": 0,
    "cpuCount": 0,
    "lifecycleState": "string",
    "documentExpirationTimeMicros": "string",
    "parentLink": "string",
    "address": "string",
    "diskLinks": [
        "string"
    ],
    "endpointLink": "string",
    "instanceType": "string",
    "descriptionLink": "string",
    "cpuMhzPerCore": 0,
    "documentUpdateTimeMicros": "string",
    "primaryMAC": "string",
    "totalMemoryBytes": 0,
    "resourcePoolLink": "string",
    "adapterManagementReference": "string",
    "networkInterfaceLinks": [
        "string"
    ],
    "regionId": "string",
    "documentSelfLink": "string",
    "name": "string",
    "tenantLinks": [
        "string"
    ]
}
string
hostName
Optional

hostName

string
type
Optional

type

Possible values are : VM_HOST, VM_GUEST, DOCKER_CONTAINER, PHYSICAL, OS_ON_PHYSICAL, ZONE,
string
powerState
Optional

powerState

string
environmentName
Optional

environmentName

array of string
tagLinks
Optional

tagLinks

integer As int64 As int64
creationTimeMicros
Optional

creationTimeMicros

string
zoneId
Optional

zoneId

array of string
groupLinks
Optional

groupLinks

string
id
Optional

id

integer As int64 As int64
gpuCount
Optional

gpuCount

integer As int64 As int64
cpuCount
Optional

cpuCount

string
lifecycleState
Optional

lifecycleState

string
documentExpirationTimeMicros
Optional

documentExpirationTimeMicros

string
parentLink
Optional

parentLink

string
address
Optional

address

array of string
diskLinks
Optional

diskLinks

string
endpointLink
Optional

endpointLink

string
instanceType
Optional

instanceType

string
descriptionLink
Optional

descriptionLink

integer As int64 As int64
cpuMhzPerCore
Optional

cpuMhzPerCore

string
documentUpdateTimeMicros
Optional

documentUpdateTimeMicros

string
primaryMAC
Optional

primaryMAC

integer As int64 As int64
totalMemoryBytes
Optional

totalMemoryBytes

object
customProperties
Optional

customProperties

string
resourcePoolLink
Optional

resourcePoolLink

string As uri As uri
adapterManagementReference
Optional

adapterManagementReference

array of string
networkInterfaceLinks
Optional

networkInterfaceLinks

string
regionId
Optional

regionId

string
documentSelfLink
Optional

documentSelfLink

string
name
Optional

name

array of string
tenantLinks
Optional

tenantLinks


404

'Not Found' if no ComputeState 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