Jump to

• Request
• Response

View the Status of a Service Instance Lifecycle Operation

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/status/{requestName}/job/{jobId}

Returns the status of an Oracle Integration Classic instance lifecycle operation.

Request

Path Parameters

• identityDomainId: string
  Identity domain ID for the Oracle Integration Classic account.
• jobId: string
  Job ID.
• requestName: string
  Name of the request for which you want to view status. Valid values include:

  • create: View the status for a create service instance operation.
  • delete: View the status of a delete instance operation.
  • control: View the status of a lifecycle state control operation.

Header Parameters

• X-ID-TENANT-NAME: string
  Identity domain ID for the Oracle Integration Classic account.

Back to Top

Response

Supported Media Types

• application/vnd.com.oracle.oracloud.provisioning.Service+json

200 Response

OK (when operation is completed).

202 Response

Accepted (when operation is running).

Body ()

The response body contains information about the service instance and the status of the operation.

Root Schema : lifecyclestatus-response

Type: object

The response body contains information about the service instance and the status of the operation.

Show Source

• created_by(optional): string
  Name of the user account used to create the Oracle Integration Classic instance.
• creation_time(optional): string
  Date and time the Oracle Integration Classic instance was created.
• description(optional): string
  Free-form text that provides additional information about the service instance.
• error_status_desc(optional): string
  Error status that describes the reason that the Oracle Integration Classic instance is in an erroneous state. The following provides an example of the description:

  This service is currently in an erroneous state as the tools are in an inconsistent state. Reason - error details. Apply the latest tools patch to resume normal operations on this service.

• identity_domain(optional): string
  Identity domain ID for the Oracle Integration Classic account.
• last_modified_time(optional): string
  Date and time the Oracle Integration Classic instance was last modified.
• message(optional): array message
  Contains system messages returned during the service instance lifecycle operation.
• service_name(optional): string
  Name of Oracle Integration Classic instance.
• service_uri(optional): string
  Resource URL for the Oracle Integration Classic instance.
• status(optional): string
  Flag that specifies the status of the Oracle Integration Classic instance. Valid values include: Running, In Progress, Maintenance, Stopped, Terminating, and Failed.
• version(optional): string
  Oracle Fusion Middleware software version. For example: 12cRelease212, 12cRelease2, 12cR3 and 11g.
• wlsVersion(optional): string
  Oracle WebLogic Server software version. For example: 12.2.1.2.0, 12.2.1.0.x, 12.1.3.0.x and 10.3.6.0.x.

{
    "description":"The response body contains information about the service instance and the status of the operation.",
    "properties":{
        "created_by":{
            "type":"string",
            "description":"Name of the user account used to create the Oracle Integration Classic instance."
        },
        "creation_time":{
            "type":"string",
            "description":"Date and time the Oracle Integration Classic instance was created."
        },
        "description":{
            "type":"string",
            "description":"Free-form text that provides additional information about the service instance."
        },
        "error_status_desc":{
            "type":"string",
            "description":"Error status that describes the reason that the Oracle Integration Classic instance is in an erroneous state. The following provides an example of the description:<p><code>This service is currently in an erroneous state as the tools are in an inconsistent state. Reason - <i>error details</i>. Apply the latest tools patch to resume normal operations on this service.</code>"
        },
        "identity_domain":{
            "type":"string",
            "description":"Identity domain ID for the Oracle Integration Classic account."
        },
        "message":{
            "type":"array",
            "description":"Contains system messages returned during the service instance lifecycle operation.",
            "items":{
                "type":"string"
            }
        },
        "last_modified_time":{
            "type":"string",
            "description":"Date and time the Oracle Integration Classic instance was last modified."
        },
        "service_name":{
            "type":"string",
            "description":"Name of Oracle Integration Classic instance."
        },
        "service_uri":{
            "type":"string",
            "description":"Resource URL for the Oracle Integration Classic instance."
        },
        "status":{
            "type":"string",
            "description":"Flag that specifies the status of the Oracle Integration Classic instance. Valid values include: <code>Running</code>, <code>In Progress</code>, <code>Maintenance</code>, <code>Stopped</code>, <code>Terminating</code>, and <code>Failed</code>."
        },
        "version":{
            "type":"string",
            "description":"Oracle Fusion Middleware software version. For example: <code>12cRelease212</code>, <code>12cRelease2</code>, <code>12cR3</code> and <code>11g</code>."
        },
        "wlsVersion":{
            "type":"string",
            "description":"Oracle WebLogic Server software version. For example: <code>12.2.1.2.0</code>, <code>12.2.1.0.x</code>, <code>12.1.3.0.x</code> and <code>10.3.6.0.x</code>."
        }
    }
}

Nested Schema : message

Type: array

Contains system messages returned during the service instance lifecycle operation.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Contains system messages returned during the service instance lifecycle operation.",
    "items":{
        "type":"string"
    }
}

Back to Top