Jump to

• Request
• Response

Get Cluster Info

get

/bdcsce/api/v1.1/clustermgmt/{identityDomainId}/instances/{clusterId}

Request

Path Parameters

• clusterId: string
  Identifier for the Cluster
• identityDomainId: string
  Identity domain ID of the Oracle Cloud Service instance, used for authentication.

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

200 Response

Body ()

Root Schema : ClusterStatusSnapshot

Type: object

Show Source

• clusterInfo(optional): object ClusterInfo
• components: object ClusterComponentsInfo
• snapshotTime(optional): integer(int64)

{
    "type":"object",
    "required":[
        "components"
    ],
    "properties":{
        "clusterInfo":{
            "description":"Summarized cluster information.",
            "$ref":"#/definitions/ClusterInfo"
        },
        "components":{
            "description":"State of the cluster.",
            "$ref":"#/definitions/ClusterComponentsInfo"
        },
        "snapshotTime":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : ClusterInfo

Type: object

Show Source

• createdOn: object createdOn
  Time in milliseconds since Epoch of the creation fo the Cluster.
• deploymentProfile: string
  deploymentProfile
• id: string
  Unique Identifier of this Cluster.
• isIdcsEnabled: boolean
  Default Value: false

  Is the cluster IDCS enabled
• name: string
  Name of the cluster.
• state: string
  Allowed Values: [ "active", "readonly", "shuttingdown", "undefined" ]

  State of the cluster.
• storageType: string
  Allowed Values: [ "unknown", "nimbula", "bmc" ]

  storageType

{
    "type":"object",
    "required":[
        "createdOn",
        "deploymentProfile",
        "id",
        "isIdcsEnabled",
        "name",
        "state",
        "storageType"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique Identifier of this Cluster."
        },
        "name":{
            "type":"string",
            "description":"Name of the cluster."
        },
        "createdOn":{
            "type":"object",
            "description":"Time in milliseconds since Epoch of the creation fo the Cluster."
        },
        "state":{
            "type":"string",
            "description":"State of the cluster.",
            "enum":[
                "active",
                "readonly",
                "shuttingdown",
                "undefined"
            ]
        },
        "isIdcsEnabled":{
            "type":"boolean",
            "description":"Is the cluster IDCS enabled",
            "default":false
        },
        "deploymentProfile":{
            "type":"string",
            "description":"deploymentProfile"
        },
        "storageType":{
            "type":"string",
            "description":"storageType",
            "enum":[
                "unknown",
                "nimbula",
                "bmc"
            ]
        }
    }
}

Nested Schema : ClusterComponentsInfo

Type: object

Show Source

• imageVersion: string
  Version of the Oracle Product
• platform: array platform
  List of packages and their versions that conform this cluster.

{
    "type":"object",
    "required":[
        "imageVersion",
        "platform"
    ],
    "properties":{
        "imageVersion":{
            "type":"string",
            "description":"Version of the Oracle Product"
        },
        "platform":{
            "type":"array",
            "description":"List of packages and their versions that conform this cluster.",
            "items":{
                "$ref":"#/definitions/ClusterPackageVersionInfo"
            }
        }
    }
}

Nested Schema : createdOn

Type: object

Time in milliseconds since Epoch of the creation fo the Cluster.

Nested Schema : platform

Type: array

List of packages and their versions that conform this cluster.

Show Source

• [0]: object ClusterPackageVersionInfo

{
    "type":"array",
    "description":"List of packages and their versions that conform this cluster.",
    "items":{
        "$ref":"#/definitions/ClusterPackageVersionInfo"
    }
}

Nested Schema : ClusterPackageVersionInfo

Type: object

Show Source

• name(optional): string
• version(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "version":{
            "type":"string"
        }
    }
}

400 Response

List of errors related to the request.

Body ()

Root Schema : schema

Type: array

Show Source

• [0]: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

404 Response

The Cluster was not found.

500 Response

An internal error occurred.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  detail
• instance(optional): string
  instance
• o:errorCode(optional): string
  Read Only: true

  error code
• o:errorDetails(optional): array o:errorDetails
  Read Only: true

  error details
• o:errorPath(optional): string
  Read Only: true

  error path
• status: integer(int32)
  status
• title: string
  title
• type(optional): string
  Read Only: true

  RFC Link

{
    "type":"object",
    "required":[
        "status",
        "title"
    ],
    "properties":{
        "title":{
            "type":"string",
            "description":"title"
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"status"
        },
        "detail":{
            "type":"string",
            "description":"detail"
        },
        "instance":{
            "type":"string",
            "description":"instance"
        },
        "o:errorCode":{
            "type":"string",
            "description":"error code",
            "readOnly":true
        },
        "o:errorPath":{
            "type":"string",
            "description":"error path",
            "readOnly":true
        },
        "o:errorDetails":{
            "type":"array",
            "description":"error details",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Error"
            }
        },
        "type":{
            "type":"string",
            "description":"RFC Link",
            "readOnly":true
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Read Only: true

error details

Show Source

• [0]: object Error

{
    "type":"array",
    "description":"error details",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top