Create Compute State

• Compute Management

Only Solution users, Container admins, and System admins can create ComputeStates.

Request

URI

POST

https://{api_host}/container-service/api/resources/compute

COPY

Request Body

ComputeState of type(s) application/json

Required

{
    "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

Responses

200

Hide Details

successful operation

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

201

Hide Details

'Created' is returned for the new state with the state url in the location header of the response;

Operation doesn't return any data structure

On This Page

Description

Request

Request Body

Response

200 Response Body

201 Response Body

Compute Management Operations

POST

Create Compute State

DELETE

Delete Compute State

GET

Get Compute State

GET

List Compute State

PATCH

Patch Compute State

PUT

Update Compute State