Jump to

• Request
• Response
• Examples

Retrieve Availability Status

get

/iot/api/v2/monitoring/availability

Returns the availability status for the Oracle IoT Cloud Service Instance. The status is either up or down. The status of the service instance depends on the status of the components. If all the components are up, the status is up; otherwise it is down. The returned response indicates the overall status of the instance, the service instance timestamp, the response time (in milliseconds), the thresholdTime(the max time taken to respond) and the significance (set only when status = "Down") .

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Availability

Type: object

The availability information for the Service Instance.

Show Source

• details(optional): array details
  Array of components status
• links(optional): array links
• responseTime(optional): integer(int32)
  Specifies the total response time in milliseconds

  Example: 10000
• significance(optional): string
  Allowed Values: [ "High", "Medium", "Low" ]

  This field will be set only if status = "Down". The highest among the significance values of the Component which are Down. If at least one "High" Component is down, top-level significance is "High". If all unhealthy components are "Medium" or "Low", top-level significance is "Medium"

  Example: High
• status(optional): string
  Allowed Values: [ "Up", "Down" ]

  The overall status of IOT Service which is either Up or Down. The status is Up when Status of all Components is Up. The status is Down when status of one of the Component is Down.

  Example: Up
• thresholdTime(optional): integer(int32)
  Specifies the maximum time in milliseconds for receiving the response from all the Components

  Example: 30000
• time(optional): string(date-time)
  Specifies the Service Instance timestamp

  Example: 2015-01-29T13:37:26Z

{
    "type":"object",
    "description":"The availability information for the Service Instance.",
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "Up",
                "Down"
            ],
            "example":"Up",
            "description":"The overall status of IOT Service which is either Up or Down. The status is Up when Status of all Components is Up. The status is Down when status of one of the Component is Down."
        },
        "time":{
            "type":"string",
            "format":"date-time",
            "example":"2015-01-29T13:37:26Z",
            "description":"Specifies the Service Instance timestamp"
        },
        "responseTime":{
            "type":"integer",
            "format":"int32",
            "example":10000,
            "description":"Specifies the total response time in milliseconds"
        },
        "thresholdTime":{
            "type":"integer",
            "format":"int32",
            "example":30000,
            "description":"Specifies the maximum time in milliseconds for receiving the response from all the Components"
        },
        "significance":{
            "type":"string",
            "enum":[
                "High",
                "Medium",
                "Low"
            ],
            "example":"High",
            "description":"This field will be set only if status = \"Down\". The highest among the significance values of the Component which are Down. If at least one \"High\" Component is down, top-level significance is \"High\". If all unhealthy components are \"Medium\" or \"Low\", top-level significance is \"Medium\""
        },
        "details":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ComponentStatus"
            },
            "description":"Array of components status"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : details

Type: array

Array of components status

Show Source

• Array of: object ComponentStatus
  The status of the Component of the Service Instance

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ComponentStatus"
    },
    "description":"Array of components status"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : ComponentStatus

Type: object

The status of the Component of the Service Instance

Show Source

• component(optional): string
  Specifies the Component name

  Example: cache
• failures(optional): array failures
  Array of Failures. This is set only when the status of the Component = "Down"
• responseTime(optional): integer(int32)
  Specifies the response time in milliseconds

  Example: 1000
• significance(optional): string
  Allowed Values: [ "High", "Medium", "Low" ]

  Specifies the significance of the Component in the overall health and availability of the Service

  Example: High
• status(optional): string
  Allowed Values: [ "Up", "Down" ]

  Specifies the Component status

  Example: Up
• thresholdTime(optional): integer(int32)
  Specifies the maximum time in milliseconds for receiving the response from the Component

  Example: 15000

{
    "type":"object",
    "description":"The status of the Component of the Service Instance",
    "properties":{
        "component":{
            "type":"string",
            "example":"cache",
            "description":"Specifies the Component name"
        },
        "status":{
            "type":"string",
            "enum":[
                "Up",
                "Down"
            ],
            "example":"Up",
            "description":"Specifies the Component status"
        },
        "responseTime":{
            "type":"integer",
            "format":"int32",
            "example":1000,
            "description":"Specifies the response time in milliseconds"
        },
        "thresholdTime":{
            "type":"integer",
            "format":"int32",
            "example":15000,
            "description":"Specifies the maximum time in milliseconds for receiving the response from the Component"
        },
        "significance":{
            "type":"string",
            "enum":[
                "High",
                "Medium",
                "Low"
            ],
            "example":"High",
            "description":"Specifies the significance of the Component in the overall health and availability of the Service"
        },
        "failures":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Failures"
            },
            "description":"Array of Failures. This is set only when the status of the Component = \"Down\""
        }
    }
}

Nested Schema : failures

Type: array

Array of Failures. This is set only when the status of the Component = "Down"

Show Source

• Array of: object Failures
  The failure details

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Failures"
    },
    "description":"Array of Failures. This is set only when the status of the Component = \"Down\""
}

Nested Schema : Failures

Type: object

The failure details

Show Source

• errorMessage(optional): string
  The error message describing the failure

  Example: Failed to connect to the database
• rootCause(optional): string
  Allowed Values: [ "TIMEOUT", "UNHEALTHY", "CONNECTION_FAILURE" ]

  The root cause of failure

  Example: TIMEOUT

{
    "type":"object",
    "description":"The failure details",
    "properties":{
        "rootCause":{
            "type":"string",
            "enum":[
                "TIMEOUT",
                "UNHEALTHY",
                "CONNECTION_FAILURE"
            ],
            "example":"TIMEOUT",
            "description":"The root cause of failure"
        },
        "errorMessage":{
            "type":"string",
            "example":"Failed to connect to the database",
            "description":"The error message describing the failure"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
  Example: https://iotserver/iot/api/v2/monitoring/metrics/test
• rel(optional): string
  Example: canonical

{
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"https://iotserver/iot/api/v2/monitoring/metrics/test"
        }
    }
}

401 Response

Unauthorized. This error is returned if the access token is not valid or has expired.

403 Response

Forbidden. This error is returned if the operation is not allowed for the request.

Back to Top

Examples

The following example shows how to view the availability status of the IoT Cloud Service instance by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Note:

In the request and response, iotserver will be replaced by name and port of your assigned Oracle IoT Cloud Service instance. The format of the Cloud Service instance is myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.

curl -X GET -k -H 'Accept: application/json' -u '[e-mail]:password' http://iotserver/iot/api/v2/monitoring/availability

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "status": "Up",
    "time": "2021-08-19T09:31:31.080Z",
    "responseTime": 280,
    "thresholdTime": 30000,
    "details": [
        {
            "component": "cache",
            "status": "Up",
            "responseTime": 1,
            "thresholdTime": 5000,
            "significance": "High"
        },
        {
            "component": "database",
            "status": "Up",
            "responseTime": 3,
            "thresholdTime": 10000,
            "significance": "High"
        },
        {
            "component": "searchEngine",
            "status": "Up",
            "responseTime": 3,
            "thresholdTime": 5000,
            "significance": "High"
        },
        {
            "component": "messageBus",
            "status": "Up",
            "responseTime": 8,
            "thresholdTime": 10000,
            "significance": "Medium"
        },
        {
            "component": "analyticsEngine",
            "status": "Up",
            "responseTime": 82,
            "thresholdTime": 20000,
            "significance": "High"
        },
        {
            "component": "storage",
            "status": "Up",
            "responseTime": 131,
            "thresholdTime": 15000,
            "significance": "Medium"
        },
        {
            "component": "credentialStore",
            "status": "Up",
            "responseTime": 280,
            "thresholdTime": 15000,
            "significance": "High"
        }
    ],
    "links": [
        {
            "href":"http://iotserver/iot/api/v2/monitoring/availability",
            "rel": "self"
        },
        {
            "href":"http://iotserver/iot/api/v2/monitoring/availability",
            "rel": "canonical"
        }
    ]
}

Back to Top