Jump to

• Request
• Response

Stop a Service Instance

post

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/hosts/stop

Stop one or more VMs that are running as part of the Oracle Data Hub Cloud Service instance.

Request

Supported Media Types

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

Path Parameters

• identityDomainId: string
  Identity domain ID for the Oracle Data Hub Cloud Service account.
• serviceId: string
  Name of the Oracle Data Hub Cloud Service instance.

Body ()

The request body defines the hosts to stop.

Root Schema : Request Body

Type: object

Title: Request Body

Show Source

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

{
    "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 or if associated services could be interrupted."
        },
        "allServiceHosts":{
            "type":"string",
            "description":"Set to 'true' to perform the administration action on all hosts."
        },
        "components":{
            "$ref":"#/definitions/stop-components"
        }
    },
    "title":"Request Body"
}

Nested Schema : Component Parameters

Type: object

Title: Component Parameters

Show Source

• CASSANDRA: object CASSANDRA
  Title: CASSANDRA

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

Nested Schema : CASSANDRA

Type: object

Title: CASSANDRA

Show Source

• hosts: array hosts
  Nodes to be controlled.

{
    "type":"object",
    "properties":{
        "hosts":{
            "type":"array",
            "description":"Nodes to be controlled.",
            "items":{
                "type":"string"
            }
        }
    },
    "title":"CASSANDRA"
}

Nested Schema : hosts

Type: array

Nodes to be controlled.

Show Source

• [0]: string

{
    "type":"array",
    "description":"Nodes to be controlled.",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

• application/json

202 Response

Accepted

Body ()

Root Schema : accepted-response

Type: object

Show Source

• jobId: string
  Job ID of the operation.
• message: 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."
        }
    }
}