Jump to

• Request
• Response

Get all ComputeNode objects that meet the filter criteria.

put

https://{host}:{port}/{basePath}/ComputeNode/filter

get all ComputeNode objects that meet the filter criteria.

Request

Header Parameters

• Auth-Token(required): string
  Auth-Token received from a successful login response.
• opc-request-id: string
  Unique identifier for the request

Supported Media Types

• application/x-www-form-urlencoded

Request Body - application/x-www-form-urlencoded ()

Root Schema : schema

Type: object

Show Source

• filter: object Filter

{
    "properties":{
        "filter":{
            "$ref":"#/components/schemas/Filter",
            "type":"object"
        }
    }
}

Nested Schema : Filter

Type: object

Show Source

• description(required): string
  Maximum Length: 1000
• faultIds: array faultIds
• filterConditions: array filterConditions
• generation: integer
• maxResults: integer
• name(required): string
  Maximum Length: 256
• objType: string
  Maximum Length: 64
• orderByList: array orderByList
• orderType: string
  Allowed Values: [ "ASCENDING", "DESCENDING" ]
• workState: string

{
    "properties":{
        "objType":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "maxResults":{
            "description":"",
            "type":"integer"
        },
        "orderByList":{
            "description":"",
            "type":"array"
        },
        "orderType":{
            "description":"",
            "enum":[
                "ASCENDING",
                "DESCENDING"
            ],
            "type":"string"
        },
        "filterConditions":{
            "description":"",
            "type":"array"
        },
        "description":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "generation":{
            "description":"",
            "type":"integer"
        },
        "name":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "workState":{
            "description":"",
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "description",
        "name"
    ],
    "type":"object",
    "description":""
}

Nested Schema : faultIds

Type: array

Nested Schema : filterConditions

Type: array

Nested Schema : orderByList

Type: array

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ComputeNode
  The ComputeNode object represents a physical Compute Node within the Rack.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ComputeNode"
    }
}

Nested Schema : ComputeNode

Type: object

The ComputeNode object represents a physical Compute Node within the Rack.

Show Source

• bootTime: string
  Maximum Length: 64
• cnConnectivity: string
  Maximum Length: 64
• coreCount: string
  Maximum Length: 64
• cpuUsagePercent: number
• cpuUtilizationIndicator: string
  Allowed Values: [ "CRITICAL", "MAJOR", "MINOR", "WARNING" ]
• dataMac: string
  Maximum Length: 64
• description(required): string
  Maximum Length: 1000
• eclassIp: string
  Maximum Length: 64
• eclassNetMask: string
  Maximum Length: 64
• faultDomain: string
  Allowed Values: [ "UNASSIGNED", "FD1", "FD2", "FD3" ]
• faultIds: array faultIds
• firmwareVersion: string
  Maximum Length: 64
• freeCPUs: string
  Maximum Length: 64
• freeGpuCount: integer
• freeMemory: string
  Maximum Length: 64
• generation: integer
• gpuCount: integer
• gpuType: string
  Maximum Length: 64
• hardwareComponentIds: array hardwareComponentIds
• hostname: string
  Maximum Length: 64
• hwId: string
  Maximum Length: 64
• ilomHostname: string
  Maximum Length: 64
• ilomIp: string
  Maximum Length: 64
• ilomMac: string
  Maximum Length: 64
• ilomRunStateFault: string
  Allowed Values: [ "CRITICAL", "MAJOR", "MINOR", "WARNING" ]
• ilomState: string
  Maximum Length: 64
• installedMemory: string
  Maximum Length: 64
• ipAddress: string
  Maximum Length: 64
• macAddress: string
  Maximum Length: 64
• maintenanceLocked: boolean
• memoryUsagePercent: number
• memoryUtilizationIndicator: string
  Allowed Values: [ "CRITICAL", "MAJOR", "MINOR", "WARNING" ]
• model: string
  Maximum Length: 64
• name(required): string
  Maximum Length: 256
• numberOfCPUs: integer
• os: string
  Maximum Length: 64
• processor: string
  Maximum Length: 64
• progressRecordIds: array progressRecordIds
• provisioningLocked: boolean
• provisioningState: string
  Allowed Values: [ "READYTOPROVISION", "PROVISIONING", "DEPROVISIONING", "PROVISIONED", "FAILED" ]
• provisioningStateLastChangedTime: timestamp
• provisioningType: string
  Allowed Values: [ "KVM", "BAREMETAL", "UNSPECIFIED" ]
• rackElevation: string
  Maximum Length: 64
• rackId: object Rack
  The Rack object represents a physical PCA Rack.
• runStateFault: string
  Allowed Values: [ "CRITICAL", "MAJOR", "MINOR", "WARNING" ]
• serialNumber: string
  Maximum Length: 64
• state: string
  Maximum Length: 64
• tenantId: object Tenant
  A Tenant object represents an OCI Tenant.
• totalCPUs: string
  Maximum Length: 64
• totalMemory: string
  Maximum Length: 64
• upgradeRunning: boolean
• validationState: string
• vendor: string
  Maximum Length: 64
• workState: string

{
    "properties":{
        "provisioningState":{
            "description":"",
            "enum":[
                "READYTOPROVISION",
                "PROVISIONING",
                "DEPROVISIONING",
                "PROVISIONED",
                "FAILED"
            ],
            "type":"string"
        },
        "provisioningStateLastChangedTime":{
            "description":"",
            "type":"timestamp"
        },
        "provisioningType":{
            "description":"",
            "enum":[
                "KVM",
                "BAREMETAL",
                "UNSPECIFIED"
            ],
            "type":"string"
        },
        "faultDomain":{
            "description":"",
            "enum":[
                "UNASSIGNED",
                "FD1",
                "FD2",
                "FD3"
            ],
            "type":"string"
        },
        "installedMemory":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "freeMemory":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "totalMemory":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "bootTime":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "numberOfCPUs":{
            "description":"",
            "type":"integer"
        },
        "freeCPUs":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "totalCPUs":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "processor":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "provisioningLocked":{
            "description":"",
            "type":"boolean"
        },
        "maintenanceLocked":{
            "description":"",
            "type":"boolean"
        },
        "eclassIp":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "eclassNetMask":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "dataMac":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "cnConnectivity":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "cpuUsagePercent":{
            "description":"",
            "type":"number"
        },
        "memoryUsagePercent":{
            "description":"",
            "type":"number"
        },
        "cpuUtilizationIndicator":{
            "description":"",
            "enum":[
                "CRITICAL",
                "MAJOR",
                "MINOR",
                "WARNING"
            ],
            "type":"string"
        },
        "memoryUtilizationIndicator":{
            "description":"",
            "enum":[
                "CRITICAL",
                "MAJOR",
                "MINOR",
                "WARNING"
            ],
            "type":"string"
        },
        "upgradeRunning":{
            "description":"",
            "type":"boolean"
        },
        "gpuType":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "gpuCount":{
            "description":"",
            "type":"integer"
        },
        "freeGpuCount":{
            "description":"",
            "type":"integer"
        },
        "tenantId":{
            "description":"",
            "$ref":"#/components/schemas/Tenant"
        },
        "progressRecordIds":{
            "description":"",
            "type":"array"
        },
        "hwId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "macAddress":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "ipAddress":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "ilomIp":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "ilomMac":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "ilomHostname":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "ilomState":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "hostname":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "model":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "os":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "vendor":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "firmwareVersion":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "serialNumber":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "state":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "rackElevation":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "validationState":{
            "description":"",
            "type":"string"
        },
        "runStateFault":{
            "description":"",
            "enum":[
                "CRITICAL",
                "MAJOR",
                "MINOR",
                "WARNING"
            ],
            "type":"string"
        },
        "ilomRunStateFault":{
            "description":"",
            "enum":[
                "CRITICAL",
                "MAJOR",
                "MINOR",
                "WARNING"
            ],
            "type":"string"
        },
        "coreCount":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "hardwareComponentIds":{
            "description":"",
            "type":"array"
        },
        "rackId":{
            "description":"",
            "$ref":"#/components/schemas/Rack"
        },
        "description":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "generation":{
            "description":"",
            "type":"integer"
        },
        "name":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "workState":{
            "description":"",
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "description",
        "name"
    ],
    "type":"object",
    "description":"The ComputeNode object represents a physical Compute Node within the Rack."
}

Nested Schema : faultIds

Type: array

Nested Schema : hardwareComponentIds

Type: array

Nested Schema : progressRecordIds

Type: array

Nested Schema : Rack

Type: object

The Rack object represents a physical PCA Rack.

Show Source

• description(required): string
  Maximum Length: 1000
• faultIds: array faultIds
• generation: integer
• name(required): string
  Maximum Length: 256
• rackNumber: integer
• rackSerialNumber: string
  Maximum Length: 64
• rackType: string
  Maximum Length: 64
• rackUnitIds: array rackUnitIds
• validationState: string
  Allowed Values: [ "VALIDATED", "ERROR", "UNKNOWN" ]
• workState: string

{
    "properties":{
        "rackNumber":{
            "description":"",
            "type":"integer"
        },
        "rackSerialNumber":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "rackType":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "validationState":{
            "description":"",
            "enum":[
                "VALIDATED",
                "ERROR",
                "UNKNOWN"
            ],
            "type":"string"
        },
        "rackUnitIds":{
            "description":"",
            "type":"array"
        },
        "description":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "generation":{
            "description":"",
            "type":"integer"
        },
        "name":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "workState":{
            "description":"",
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "description",
        "name"
    ],
    "type":"object",
    "description":"The Rack object represents a physical PCA Rack."
}

Nested Schema : Tenant

Type: object

A Tenant object represents an OCI Tenant.

Show Source

• adminPassword(required): string
  Maximum Length: 100
• adminUserName(required): string
  Maximum Length: 100
• computeNodeIds: array computeNodeIds
• confirmPassword(required): string
  Maximum Length: 100
• description(required): string
  Maximum Length: 1000
• faultIds: array faultIds
• name(required): string
  Maximum Length: 100
• operStatus: string
  Allowed Values: [ "CREATING", "DELETING", "CREATED", "FAILED" ]
• serviceNamespace(required): string
  Maximum Length: 256

{
    "properties":{
        "operStatus":{
            "description":"",
            "enum":[
                "CREATING",
                "DELETING",
                "CREATED",
                "FAILED"
            ],
            "type":"string"
        },
        "name":{
            "description":"",
            "maxLength":100,
            "type":"string"
        },
        "adminUserName":{
            "description":"",
            "maxLength":100,
            "type":"string"
        },
        "adminPassword":{
            "description":"",
            "maxLength":100,
            "type":"string"
        },
        "confirmPassword":{
            "description":"",
            "maxLength":100,
            "type":"string"
        },
        "description":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "serviceNamespace":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "computeNodeIds":{
            "description":"",
            "type":"array"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "name",
        "adminUserName",
        "adminPassword",
        "confirmPassword",
        "description",
        "serviceNamespace"
    ],
    "type":"object",
    "description":"A Tenant object represents an OCI Tenant."
}

Nested Schema : faultIds

Type: array

Nested Schema : rackUnitIds

Type: array

Nested Schema : computeNodeIds

Type: array

Nested Schema : faultIds

Type: array

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top