REST API for Oracle Private Cloud Appliance Service Enclave

Get all ProgressRecord objects by the list of ids.

put

https://{host}:{port}/{basePath}/ProgressRecord/

get all ProgressRecord objects by the list of ids.

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

Root Schema : schema

Type: object

Show Source

GetProgressRecordByIdsIdsParam: array GetProgressRecordByIdsIdsParam

List of ids to retrieve the associated ProgressRecords.

{
    "properties":{
        "GetProgressRecordByIdsIdsParam":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"List of ids to retrieve the associated ProgressRecords."
        }
    }
}

Nested Schema : GetProgressRecordByIdsIdsParam

Type: array

List of ids to retrieve the associated ProgressRecords.

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"List of ids to retrieve the associated ProgressRecords."
}

Security

basicAuth: http

Type: http

Response

Supported Media Types

application/json

200 Response

Request completed successfully.

Root Schema : schema

Type: array

Show Source

Array of: object ProgressRecord

oracle.doceng.json.BetterJsonNull@15ade272

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

Nested Schema : ProgressRecord

Type: object

oracle.doceng.json.BetterJsonNull@15ade272

Show Source

action: string

Maximum Length: 64

The action taken is read-only and this operation is unsupported.
cnId: string

Maximum Length: 1000

The details is read-only and this operation is unsupported.
computeNodeId: object ComputeNode

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

Maximum Length: 1000

The details is read-only and this operation is unsupported.
faultIds: array faultIds
localEndpointId: object LocalEndpoint

oracle.doceng.json.BetterJsonNull@6b899971
peerConnectionId: object PeerConnection

The PeerConnection object represents one DR peering between two different PCA racks.
timeOfOccurrence: timestamp

The time of occurence is read-only and this operation is unsupported.

{
    "properties":{
        "action":{
            "description":"The action taken is read-only and this operation is unsupported.",
            "maxLength":64,
            "type":"string"
        },
        "timeOfOccurrence":{
            "description":"The time of occurence is read-only and this operation is unsupported.",
            "type":"timestamp"
        },
        "details":{
            "description":"The details is read-only and this operation is unsupported.",
            "maxLength":1000,
            "type":"string"
        },
        "cnId":{
            "description":"The details is read-only and this operation is unsupported.",
            "maxLength":1000,
            "type":"string"
        },
        "computeNodeId":{
            "description":"",
            "$ref":"#/components/schemas/ComputeNode"
        },
        "localEndpointId":{
            "description":"",
            "$ref":"#/components/schemas/LocalEndpoint"
        },
        "peerConnectionId":{
            "description":"",
            "$ref":"#/components/schemas/PeerConnection"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "type":"object",
    "description":null
}

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 : LocalEndpoint

Type: object

oracle.doceng.json.BetterJsonNull@6b899971

Show Source

datacenterGateway1Ip(required): string

Maximum Length: 64
datacenterGateway2Ip(required): string

Maximum Length: 64
faultIds: array faultIds
lifecycleState: string

Allowed Values: [ "CREATING", "ACTIVE", "DELETING", "DELETED", "UPDATING", "UPDATED", "FAILED", "UNKNOWN" ]
lifecycleStateDescription: string

Maximum Length: 1000
lifecycleSubState: string

Allowed Values: [ "CREATING_LOCAL_ENDPOINT", "FAILED_CREATING_LOCAL_ENDPOINT", "CREATING_ZFSSA_LOCAL_ENDPOINT", "FAILED_CREATING_ZFSSA_LOCAL_ENDPOINT", "ACTIVE", "DELETING_LOCAL_ENDPOINT", "FAILED_DELETING_LOCAL_ENDPOINT", "DELETING_ZFSSA_LOCAL_ENDPOINT", "FAILED_DELETING_ZFSSA_LOCAL_ENDPOINT", "UPDATING_LOCAL_ENDPOINT", "FAILED_UPDATING_LOCAL_ENDPOINT", "UPDATING_ZFSSA_LOCAL_ENDPOINT", "FAILED_UPDATING_ZFSSA_LOCAL_ENDPOINT", "UPDATED", "DELETED", "UNKNOWN" ]
localAsn(required): string

Maximum Length: 64
progressRecordIds: array progressRecordIds
spine1Ip(required): string

Maximum Length: 64
spine2Ip(required): string

Maximum Length: 64
timeCreated: string

Maximum Length: 64
timeUpdated: string

Maximum Length: 64
zfsCapacityPoolEndpointIp(required): string

Maximum Length: 64
zfsPerformancePoolEndpointIp(required): string

Maximum Length: 64

{
    "properties":{
        "lifecycleState":{
            "description":"",
            "enum":[
                "CREATING",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "UPDATING",
                "UPDATED",
                "FAILED",
                "UNKNOWN"
            ],
            "type":"string"
        },
        "lifecycleSubState":{
            "description":"",
            "enum":[
                "CREATING_LOCAL_ENDPOINT",
                "FAILED_CREATING_LOCAL_ENDPOINT",
                "CREATING_ZFSSA_LOCAL_ENDPOINT",
                "FAILED_CREATING_ZFSSA_LOCAL_ENDPOINT",
                "ACTIVE",
                "DELETING_LOCAL_ENDPOINT",
                "FAILED_DELETING_LOCAL_ENDPOINT",
                "DELETING_ZFSSA_LOCAL_ENDPOINT",
                "FAILED_DELETING_ZFSSA_LOCAL_ENDPOINT",
                "UPDATING_LOCAL_ENDPOINT",
                "FAILED_UPDATING_LOCAL_ENDPOINT",
                "UPDATING_ZFSSA_LOCAL_ENDPOINT",
                "FAILED_UPDATING_ZFSSA_LOCAL_ENDPOINT",
                "UPDATED",
                "DELETED",
                "UNKNOWN"
            ],
            "type":"string"
        },
        "lifecycleStateDescription":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "timeUpdated":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "timeCreated":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "spine1Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "spine2Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "datacenterGateway1Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "datacenterGateway2Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "zfsCapacityPoolEndpointIp":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "zfsPerformancePoolEndpointIp":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "localAsn":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "progressRecordIds":{
            "description":"",
            "type":"array"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "spine1Ip",
        "spine2Ip",
        "datacenterGateway1Ip",
        "datacenterGateway2Ip",
        "zfsCapacityPoolEndpointIp",
        "zfsPerformancePoolEndpointIp",
        "localAsn"
    ],
    "type":"object",
    "description":null
}

Nested Schema : PeerConnection

Type: object

The PeerConnection object represents one DR peering between two different PCA racks.

Show Source

description(required): string

Maximum Length: 1000
displayName(required): string

Maximum Length: 200
faultIds: array faultIds
generation: integer
lifecycleState: string

Allowed Values: [ "CREATING", "WAITING_FOR_CREATE_PEER_CONNECTION", "WAITING_FOR_PEER", "CREATE_ZFSSA_PEER_CONNECTION", "WAIT_FOR_CREATE_ZFSSA_PEER_CONNECTION", "TRUST_EXCHANGE", "SHARING_TRUST", "ACTIVE", "DELETING", "DELETED", "WAIT_FOR_DELETE_ZFSSA_PEER_CONNECTION", "WAIT_FOR_DELETE_PEER_CONNECTION", "UPDATING", "UPDATED", "FAILED", "FAILED_DELETING_ZFSSA_PEER_CONNECTION", "FAILED_DELETING_PEER_CONNECTION", "CLEANUP_FAILURE", "CLEANUP_SUCCESS", "UNKNOWN", "ERROR" ]
lifecycleStateDescription: string

Maximum Length: 1000
lifecycleSubState: string

Allowed Values: [ "CREATING", "WAITING_FOR_PEER", "WAITING_FOR_CREATE_PEER_CONNECTION", "CREATE_ZFSSA_PEER_CONNECTION", "WAIT_FOR_CREATE_ZFSSA_PEER_CONNECTION", "TRUST_EXCHANGE", "SHARING_TRUST", "ACTIVE", "DELETING", "DELETED", "WAIT_FOR_DELETE_ZFSSA_PEER_CONNECTION", "WAIT_FOR_DELETE_PEER_CONNECTION", "UPDATING", "UPDATED", "FAILED", "FAILED_CREATING_PEERCONNECTION", "FAILED_TRUST_EXCHANGE", "FAILED_ZFSSA_PEERCONNECTION", "CLEANUP_FAILURE", "CLEANUP_SUCCESS", "UNKNOWN", "ERROR" ]
localEndpoint1Ip(required): string

Maximum Length: 64
localEndpoint2Ip(required): string

Maximum Length: 64
name(required): string

Maximum Length: 256
peerAdminCaChain(required): string

Maximum Length: 10000
peerAdminHostname(required): string

Maximum Length: 64
peerAdminPassword(required): string

Maximum Length: 100
peerAdminUserName(required): string

Maximum Length: 64
peerDomainName(required): string

Maximum Length: 64
peerSerialNumber(required): string

Maximum Length: 100
peerSystemName(required): string

Maximum Length: 64
progressRecordIds: array progressRecordIds
remoteAsn(required): string

Maximum Length: 64
remoteEndpoint1Ip(required): string

Maximum Length: 64
remoteEndpoint2Ip(required): string

Maximum Length: 64
remoteSpine1Ip(required): string

Maximum Length: 64
remoteSpine2Ip(required): string

Maximum Length: 64
timeCreated: string

Maximum Length: 64
timeUpdated: string

Maximum Length: 64
workState: string

{
    "properties":{
        "lifecycleSubState":{
            "description":"",
            "enum":[
                "CREATING",
                "WAITING_FOR_PEER",
                "WAITING_FOR_CREATE_PEER_CONNECTION",
                "CREATE_ZFSSA_PEER_CONNECTION",
                "WAIT_FOR_CREATE_ZFSSA_PEER_CONNECTION",
                "TRUST_EXCHANGE",
                "SHARING_TRUST",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "WAIT_FOR_DELETE_ZFSSA_PEER_CONNECTION",
                "WAIT_FOR_DELETE_PEER_CONNECTION",
                "UPDATING",
                "UPDATED",
                "FAILED",
                "FAILED_CREATING_PEERCONNECTION",
                "FAILED_TRUST_EXCHANGE",
                "FAILED_ZFSSA_PEERCONNECTION",
                "CLEANUP_FAILURE",
                "CLEANUP_SUCCESS",
                "UNKNOWN",
                "ERROR"
            ],
            "type":"string"
        },
        "lifecycleState":{
            "description":"",
            "enum":[
                "CREATING",
                "WAITING_FOR_CREATE_PEER_CONNECTION",
                "WAITING_FOR_PEER",
                "CREATE_ZFSSA_PEER_CONNECTION",
                "WAIT_FOR_CREATE_ZFSSA_PEER_CONNECTION",
                "TRUST_EXCHANGE",
                "SHARING_TRUST",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "WAIT_FOR_DELETE_ZFSSA_PEER_CONNECTION",
                "WAIT_FOR_DELETE_PEER_CONNECTION",
                "UPDATING",
                "UPDATED",
                "FAILED",
                "FAILED_DELETING_ZFSSA_PEER_CONNECTION",
                "FAILED_DELETING_PEER_CONNECTION",
                "CLEANUP_FAILURE",
                "CLEANUP_SUCCESS",
                "UNKNOWN",
                "ERROR"
            ],
            "type":"string"
        },
        "lifecycleStateDescription":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "displayName":{
            "description":"",
            "maxLength":200,
            "type":"string"
        },
        "peerSerialNumber":{
            "description":"",
            "maxLength":100,
            "type":"string"
        },
        "localEndpoint1Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "localEndpoint2Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "remoteEndpoint1Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "remoteEndpoint2Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "remoteSpine1Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "remoteSpine2Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "peerAdminCaChain":{
            "description":"",
            "maxLength":10000,
            "type":"string"
        },
        "peerAdminHostname":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "peerDomainName":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "peerSystemName":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "timeUpdated":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "timeCreated":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "peerAdminUserName":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "peerAdminPassword":{
            "description":"",
            "maxLength":100,
            "type":"string"
        },
        "remoteAsn":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "progressRecordIds":{
            "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":[
        "displayName",
        "peerSerialNumber",
        "localEndpoint1Ip",
        "localEndpoint2Ip",
        "remoteEndpoint1Ip",
        "remoteEndpoint2Ip",
        "remoteSpine1Ip",
        "remoteSpine2Ip",
        "peerAdminCaChain",
        "peerAdminHostname",
        "peerDomainName",
        "peerSystemName",
        "peerAdminUserName",
        "peerAdminPassword",
        "remoteAsn",
        "description",
        "name"
    ],
    "type":"object",
    "description":"The PeerConnection object represents one DR peering between two different PCA racks."
}

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

Nested Schema : faultIds

Type: array

Nested Schema : progressRecordIds

Type: array

Nested Schema : faultIds

Type: array

Nested Schema : progressRecordIds

Type: array

400 Response

Bad request

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

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

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

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

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