Jump to

• Request
• Response
• Examples

Restart a Service Instance

post

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/hosts/restart

Restart one or more VMs that are running Oracle Integration Classic instance.

Request

Supported Media Types

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

Path Parameters

• identityDomainId: string
  Name of the identity domain for the service account
• service_name: string
  Name of the Integration Cloud instance

Header Parameters

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

Body ()

JSON payload for this REST endpoint

Root Schema : Request Body

Type: object

Title: Request Body

Show Source

• allServiceHosts(optional): string
  Set to 'true' to perform the administration action on all hosts
• components(optional): object Component Parameters
  Title: Component Parameters
• force(optional): string
  This parameter is optional and is used to force the host to be stopped even if control script execution fails

{
    "type":"object",
    "properties":{
        "force":{
            "type":"string",
            "description":"This parameter is optional and is used to force the host to be stopped even if control script execution fails"
        },
        "allServiceHosts":{
            "type":"string",
            "description":"Set to 'true' to perform the administration action on all hosts"
        },
        "components":{
            "$ref":"#/definitions/restart-components"
        }
    },
    "title":"Request Body"
}

Nested Schema : Component Parameters

Type: object

Title: Component Parameters

Show Source

• WLS(optional): object WLS
  Title: WLS

{
    "type":"object",
    "properties":{
        "WLS":{
            "$ref":"#/definitions/restart-components-WLS"
        }
    },
    "title":"Component Parameters"
}

Nested Schema : WLS

Type: object

Title: WLS

Show Source

• hosts(optional): array hosts
  Weblogic server to be controlled

{
    "type":"object",
    "properties":{
        "hosts":{
            "type":"array",
            "description":"Weblogic server to be controlled",
            "items":{
                "type":"string"
            }
        }
    },
    "title":"WLS"
}

Nested Schema : hosts

Type: array

Weblogic server to be controlled

Show Source

• Array of: string

{
    "type":"array",
    "description":"Weblogic server to be controlled",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted

Body ()

Root Schema : accepted-response

Type: object

Show Source

• jobId(optional): string
  Job ID of the operation.
• message(optional): string
  System message that describes the operation. For example: Submitted job to create service [{serviceName}] in domain [{identityDomainId}].

{
    "properties":{
        "message":{
            "type":"string",
            "description":"System message that describes the operation. For example: <code>Submitted job to create service [{serviceName}] in domain [{identityDomainId}].</code>"
        },
        "jobId":{
            "type":"string",
            "description":"Job ID of the operation."
        }
    }
}

Back to Top

Examples

The following example shows how to restart multiple virtual machines (VM) of Oracle Integration by submitting a POST request on the REST resource using cURL.

Note:

The command in this example uses the URL structure https://example.com/resource-path, where example.com is the Oracle Cloud server to contact for your identity domain.

cURL Command

curl -v -X POST -u jstein:Password -H "Content-type:application/json" -H "Accept:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" --data @restart.json http://example.com/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/IntegrationCloud/instances/hapapatch16/hosts/restart 

Example of Request Header

The following shows an example of the response header.

headers: Content-Type:application/json
Accept: application/json
Authorization: <Basic Auth credentials>
X-ID-TENANT-NAME: <identity domain>

Example of Request Body to Restart Multiple VMs

The following shows an example of the request to restart more than one VMs in JSON format.

{
  "allServiceHosts": false,
  "components": {
    "WLS": {
      "hosts": [
        "<host_name_1>",
        "<host_name_2>",...
        ]
    }
  }
}

Example of Request Body to Restart Single VM

The following shows an example of the request to restart a single VM in JSON format.

{
  "allServiceHosts": false,
  "components": {
    "WLS": {
      "hosts": [
        "hapapatch16-wls-1 "
      ]
    }
  }
}

Back to Top