Oracle Cloud Infrastructure Documentation

Get Instance Details

Use this API to get details of a given instance.

API

/exadata/v1/customers/{customerId}/instances/{instanceId}/metrics

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can get instance details only for your customer instances.
  • You can use Exadata Scale Up or Scale Down API only if customer has opted-in for Exadata Scale Up or Scale Down functionality.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Base Path

/exadata/v1/

Functionality

This API gets details of a given instance.

Verb

GET

Parameters

Name Type Description Mandatory
customerId Path parameter Customer ID Yes
instanceId Path parameter Instance ID of a given instance Yes

Sample response

{
    "instanceId": "DWHPRD",
    "collectedOn":"2020-08-26T08:53:51-07:00",
    "metricsDBSystem": {
        "databases": [
            {
                "dbStatus": "running",
                "name": "DWHPRD",
                "ocpuCount": 42
            },
            {
                "dbStatus": "down",
                "name": "ORCL",
                "ocpuCount": 0
            }
        ],
        "name": "avvaexa01pr",
        "nodes": [
            {
                "name": " avvaexa01pr-bqaab1"
            },
            {
                "name": "avvaexa01pr-bqaab3"
            },
            {
                "name": "avvaexa01pr-bqaab4"
            },
            {
                "name": "avvaexa01pr-bqaab2"
            }
        ],
        "ocpuCount": 84,
        "shape": "Exadata.Half2.184",
        "tenancy": {
            "name": "avva01",
            "region": "uk-london-1"
        }
    }
}