Jump to

• Request
• Response

Monitor a Service Instance

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/healthcheck

Returns health monitoring data for the specified Oracle Database Classic Cloud Service instance.

For Single Instance Database Service instance, the following health metrics are provided:

• last_logon_time - Number of days since last logon.
• user_tablespace_usage - Max Percentage for a User Tablespace Used.
• active_sessions - Active number of sessions.

Note: Health monitoring metrics are updated on an hourly basis. As a result, the metrics might be slightly out-of-date until the next hourly refresh.

In the event you encounter a status 500 error when attempting to retrieve data for your service instance, append the ?format=v4 query parameter and try again.

Request

Path Parameters

• identityDomainId: string
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

• serviceId: string
  Name of the Database Classic Cloud Service instance.

Query Parameters

• format(optional): string
  Append ?format=v4 to the end of the resource path to return basic health data in situations where errors in the monitoring would have caused a status 500 to be returned.

  Note: The structure of the output when using the query parameter is not the same as the output without the parameter, but the healthcheck and metrics information is the same.

Header Parameters

• Authorization: string
  Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
• X-ID-TENANT-NAME: string
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK. See Status Codes for information about other possible HTTP status codes.

Body ()

Root Schema : Response Body

Type: object

Title: Response Body

Show Source

• identity_domain(optional): string
  Identity domain ID for the Oracle Database Classic Cloud Service account.
• service_components(optional): array service_components
  Groups the health details for Oracle Database Classic Cloud Service components.
• service_name(optional): string
  Name of the Oracle Database Classic Cloud Service instance.
• summary(optional): object summary Object
  Title: summary Object

{
    "title":"Response Body",
    "type":"object",
    "description":"",
    "properties":{
        "identity_domain":{
            "type":"string",
            "description":"Identity domain ID for the Oracle Database Classic Cloud Service account."
        },
        "service_components":{
            "type":"array",
            "description":"Groups the health details for Oracle Database Classic Cloud Service components.",
            "items":{
                "$ref":"#/definitions/monitor-instance-service_components-array-item"
            }
        },
        "service_name":{
            "type":"string",
            "description":"Name of the Oracle Database Classic Cloud Service instance."
        },
        "summary":{
            "$ref":"#/definitions/monitor-instance-summary-object"
        }
    }
}

Nested Schema : service_components

Type: array

Groups the health details for Oracle Database Classic Cloud Service components.

Show Source

• Array of: object service_components Array Item
  Title: service_components Array Item

{
    "type":"array",
    "description":"Groups the health details for Oracle Database Classic Cloud Service components.",
    "items":{
        "$ref":"#/definitions/monitor-instance-service_components-array-item"
    }
}

Nested Schema : summary Object

Type: object

Title: summary Object

Show Source

• status(optional): string
  Status of the instance. Valid values are UP, DOWN, or ERROR (indicating a system error was encountered during health check).
• status_message(optional): string
  Detailed status message.
• status_time(optional): string
  Time at which the status was recorded (UTC).

{
    "title":"summary Object",
    "type":"object",
    "description":"",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the instance. Valid values are <code>UP</code>, <code>DOWN</code>, or <code>ERROR</code> (indicating a system error was encountered during health check)."
        },
        "status_time":{
            "type":"string",
            "description":"Time at which the status was recorded (UTC)."
        },
        "status_message":{
            "type":"string",
            "description":"Detailed status message."
        }
    }
}

Nested Schema : service_components Array Item

Type: object

Title: service_components Array Item

Show Source

• component(optional): string
  Component for which health data is recorded. Component is DB for Database Classic Cloud Service instance.
• health_data(optional): array health_data
  Groups the runtime metrics for the Oracle Database Classic Cloud Service instance component.
• vms(optional): array vms
  Groups the health details of VMs associated with an Oracle Database Classic Cloud Service component.

{
    "title":"service_components Array Item",
    "properties":{
        "component":{
            "type":"string",
            "description":"Component for which health data is recorded. Component is  <code>DB</code> for Database Classic Cloud Service instance."
        },
        "health_data":{
            "type":"array",
            "description":"Groups the runtime metrics for the Oracle Database Classic Cloud Service instance component.",
            "items":{
                "$ref":"#/definitions/monitor-instance-health_data-array-item"
            }
        },
        "vms":{
            "type":"array",
            "description":"Groups the health details of VMs associated with an Oracle Database Classic Cloud Service component.",
            "items":{
                "$ref":"#/definitions/monitor-instance-vms-array-item"
            }
        }
    }
}

Nested Schema : health_data

Type: array

Groups the runtime metrics for the Oracle Database Classic Cloud Service instance component.

Show Source

• Array of: object health_data Array Item
  Title: health_data Array Item

{
    "type":"array",
    "description":"Groups the runtime metrics for the Oracle Database Classic Cloud Service instance component.",
    "items":{
        "$ref":"#/definitions/monitor-instance-health_data-array-item"
    }
}

Nested Schema : vms

Type: array

Groups the health details of VMs associated with an Oracle Database Classic Cloud Service component.

Show Source

• Array of: object vms Array Item
  Title: vms Array Item

{
    "type":"array",
    "description":"Groups the health details of VMs associated with an Oracle Database Classic Cloud Service component.",
    "items":{
        "$ref":"#/definitions/monitor-instance-vms-array-item"
    }
}

Nested Schema : health_data Array Item

Type: object

Title: health_data Array Item

Show Source

• displayName(optional): string
  Display name for the health monitoring runtime metric.
• name(optional): string
  Name of the health monitoring runtime metric.
• type(optional): string
  Data type. For example, int.
• unit(optional): string
  Unit measurement of the metric. For example, MB and ms.
• value(optional): string
  Value of the health monitoring data.

{
    "title":"health_data Array Item",
    "properties":{
        "displayName":{
            "type":"string",
            "description":"Display name for the health monitoring runtime metric."
        },
        "name":{
            "type":"string",
            "description":"Name of the health monitoring runtime metric."
        },
        "unit":{
            "type":"string",
            "description":"Unit measurement of the metric. For example, <code>MB</code> and <code>ms</code>."
        },
        "type":{
            "type":"string",
            "description":"Data type. For example, <code>int</code>."
        },
        "value":{
            "type":"string",
            "description":"Value of the health monitoring data."
        }
    }
}

Nested Schema : vms Array Item

Type: object

Title: vms Array Item

Show Source

• servers(optional): array servers
  Groups the health details of servers running on a VM.
• summary(optional): object summary
  Groups the health summary for a VM.
• vm(optional): string
  Name of the VM.

{
    "title":"vms Array Item",
    "properties":{
        "servers":{
            "type":"array",
            "description":"Groups the health details of servers running on a VM.",
            "items":{
                "$ref":"#/definitions/monitor-instance-servers-array-item"
            }
        },
        "summary":{
            "type":"object",
            "description":"Groups the health summary for a VM.",
            "properties":{
                "status":{
                    "type":"string",
                    "description":"Status of the VM. Valid values are <code>UP</code>, <code>DOWN</code>, or <code>ERROR</code> (indicating a system error was encountered during health check)."
                },
                "status_message":{
                    "type":"string",
                    "description":"Status message, if available."
                },
                "status_time":{
                    "type":"string",
                    "description":"Time at which the status was recorded (UTC)."
                },
                "sub_status":{
                    "type":"string",
                    "description":"Status of a subcomponent, if applicable."
                }
            }
        },
        "vm":{
            "type":"string",
            "description":"Name of the VM."
        }
    }
}

Nested Schema : servers

Type: array

Groups the health details of servers running on a VM.

Show Source

• Array of: object servers Array Item
  Title: servers Array Item

{
    "type":"array",
    "description":"Groups the health details of servers running on a VM.",
    "items":{
        "$ref":"#/definitions/monitor-instance-servers-array-item"
    }
}

Nested Schema : summary

Type: object

Groups the health summary for a VM.

Show Source

• status(optional): string
  Status of the VM. Valid values are UP, DOWN, or ERROR (indicating a system error was encountered during health check).
• status_message(optional): string
  Status message, if available.
• status_time(optional): string
  Time at which the status was recorded (UTC).
• sub_status(optional): string
  Status of a subcomponent, if applicable.

{
    "type":"object",
    "description":"Groups the health summary for a VM.",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the VM. Valid values are <code>UP</code>, <code>DOWN</code>, or <code>ERROR</code> (indicating a system error was encountered during health check)."
        },
        "status_message":{
            "type":"string",
            "description":"Status message, if available."
        },
        "status_time":{
            "type":"string",
            "description":"Time at which the status was recorded (UTC)."
        },
        "sub_status":{
            "type":"string",
            "description":"Status of a subcomponent, if applicable."
        }
    }
}

Nested Schema : servers Array Item

Type: object

Title: servers Array Item

Show Source

• health_data(optional): array health_data
  Groups the health details for the server.
• server_name(optional): string
  Name of the server.
• server_role(optional): string
  Server type. For example: MANAGED or ADMIN.
• summary(optional): object summary
  Groups the health status summary for the server.

{
    "title":"servers Array Item",
    "properties":{
        "health_data":{
            "type":"array",
            "description":"Groups the health details for the server.",
            "items":{
                "$ref":"#/definitions/monitor-instance-health_data-array-item"
            }
        },
        "server_name":{
            "type":"string",
            "description":"Name of the server."
        },
        "server_role":{
            "type":"string",
            "description":"Server type. For example: <code>MANAGED</code> or <code>ADMIN</code>."
        },
        "summary":{
            "type":"object",
            "description":"Groups the health status summary for the server.",
            "properties":{
                "status":{
                    "type":"string",
                    "description":"Status of the server. Valid values are <code>UP</code>, <code>DOWN</code>, or <code>ERROR</code> (indicating a system error was encountered during health check)."
                },
                "status_message":{
                    "type":"string",
                    "description":"Status message, if available."
                },
                "status_time":{
                    "type":"string",
                    "description":"Time at which the status was recorded (UTC)."
                }
            }
        }
    }
}

Nested Schema : health_data

Type: array

Groups the health details for the server.

Show Source

• Array of: object health_data Array Item
  Title: health_data Array Item

{
    "type":"array",
    "description":"Groups the health details for the server.",
    "items":{
        "$ref":"#/definitions/monitor-instance-health_data-array-item"
    }
}

Nested Schema : summary

Type: object

Groups the health status summary for the server.

Show Source

• status(optional): string
  Status of the server. Valid values are UP, DOWN, or ERROR (indicating a system error was encountered during health check).
• status_message(optional): string
  Status message, if available.
• status_time(optional): string
  Time at which the status was recorded (UTC).

{
    "type":"object",
    "description":"Groups the health status summary for the server.",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the server. Valid values are <code>UP</code>, <code>DOWN</code>, or <code>ERROR</code> (indicating a system error was encountered during health check)."
        },
        "status_message":{
            "type":"string",
            "description":"Status message, if available."
        },
        "status_time":{
            "type":"string",
            "description":"Time at which the status was recorded (UTC)."
        }
    }
}

404 Response

Not Found

500 Response

Internal Server Error

Back to Top