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",
"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",
"regionId": "string",
"networkInterfaceLinks": [
"string"
],
"documentSelfLink": "string",
"name": "string",
"tenantLinks": [
"string"
],
"desc": "string"
}string
hostName
Optional
hostName
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
string
regionId
Optional
regionId
array of string
networkInterfaceLinks
Optional
networkInterfaceLinks
string
documentSelfLink
Optional
documentSelfLink
string
name
Optional
name
array of string
tenantLinks
Optional
tenantLinks
string
desc
Optional
desc
404
'Not Found' if no ComputeState with provided id
Operation doesn't return any data structure