Jump to

• Request
• Response
• Examples

Retrieve Error Recovery Jobs

get

/ic/api/integration/v1/monitoring/errors/recoveryJobs

Retrieves a list of recovery jobs created when errored integration instances are resubmitted in a batch.

Request

Query Parameters

• expand: string

  • Includes additional details in the response about integrations, or about connections. Valid values: integration, connection.

• integrationInstance(required): string
  This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.
• limit: integer(int32)
  Use with the offset parameter for paginating through the returned results. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list error instances starting at the 4th item, and the list will contain 16 items.
• offset: integer(int32)
  Use with the limit parameter for paginating through the returned results. Default is 0. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list starting at the 4th item, and the list will contain 16 items.
• q: string

  Filter parameters.

  • timewindow: 1h, 6h, 1d, 2d, 3d, RETENTIONPERIOD. Default value is 1h.
  • startdate: Custom time range start date/time in UTC format for filtering instances.
  • enddate: Custom time range end date/time in UTC format for filtering instances.
  • primaryValue: Full or partial recovery job identifier.

  Example:

  {primaryValue:'4', startdate:'2020-07-15 07:00:00', enddate:'2020-07-08 21:10:00'}

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : RecoveryJobsRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object RecoveryJobsRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/RecoveryJobRs"
                    }
                },
                "totalResults":{
                    "type":"integer",
                    "format":"int32"
                }
            }
        }
    ]
}

Nested Schema : IdRs

Match All

Show Source

• object GenericRestRs
• object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : RecoveryJobsRs-allOf[2]

Type: object

Show Source

• items: array items
• totalResults: integer (int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RecoveryJobRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object RecoveryJobRs

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

Nested Schema : RecoveryJobRs

Type: object

Show Source

• created-date: string (date-time)
  Created Date
• failed-count: integer (int64)
  Failed Count
• in-progress-count: integer (int64)
  inProgress Count
• recovered-count: integer (int64)
  Recovered Count
• total-count: integer (int64)
  Total Count

{
    "type":"object",
    "properties":{
        "created-date":{
            "type":"string",
            "description":"Created Date",
            "format":"date-time"
        },
        "total-count":{
            "type":"integer",
            "description":"Total Count",
            "format":"int64"
        },
        "recovered-count":{
            "type":"integer",
            "description":"Recovered Count",
            "format":"int64"
        },
        "in-progress-count":{
            "type":"integer",
            "description":"inProgress Count",
            "format":"int64"
        },
        "failed-count":{
            "type":"integer",
            "description":"Failed Count",
            "format":"int64"
        }
    }
}

400 Response

Malformed parameters

500 Response

Server error

Back to Top

Examples

The following example shows how to retrieve error recovery jobs by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.

Example: Retrieve Error Recovery Jobs

Request:

curl -X GET -H 'Authorization: Bearer access_token' -H "Content-Type:application/json" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/errors/recoveryJobs?q={'timewindow':'3d'}

Back to Top