1. REST API for Oracle Database Classic Cloud Service
  2. Tasks
  3. Service Instances

View the Job Status of an Operation

get

/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/status/{requestName}/job/{jobId}

Returns the status of a Database Classic Cloud Service instance operation.

Request

Path Parameters
  • Identity domain ID for the Database Classic Cloud Service account:
     

    • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

    • For a traditional cloud account: the name of the identity domain.

  • Job ID.
  • 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 stop, start or restart operation.
Header Parameters
  • Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
  • Identity domain ID for the Database Classic Cloud Service account:
     

    • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

    • For a traditional cloud account: the name of the identity domain.

Back to Top

Response

Supported Media Types

200 Response

OK. See Status Codes for information about other possible HTTP status codes.
Body ()
Root Schema : Response Body
Type: object
Title: Response Body
Show Source
  • The Oracle Database software version in use.
    • Nested Schema : job_request_parameters Object
    Type: object
    Title: job_request_parameters Object
    Show Source
    Nested Schema : message
    Type: array
    Array of strings that contain details of operation progress.
    Show Source
    • Title: message Array Item
      String containing one operation progress message.
    Back to Top

    Examples

    The following example shows how to view status information about a request to restart a Database Classic Cloud Service instance using cURL.

    This example uses a traditional cloud account, so the {identityDomainId} path parameter and the X-ID-TENANT-NAME header parameter are set to the account's domain name, which is usexample. The Oracle Cloud user name of the user making the call is dbcsadmin. The request URI is the value returned in the Location header of a request to restart the service instance named db11g-se.

    cURL Command

    curl --include --request GET \
--user dbcsadmin:password \
--header "X-ID-TENANT-NAME:usexample" \
https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/status/control/job/101835

    HTTP Status Code and Response Headers

    HTTP/1.1 200 OK
Date: date-and-time-stamp
Server: Oracle-Application-Server-11g
Set-Cookie: OAMAuthnCookie_dbaas.oraclecloud.com:443=cookie-string
Content-Length: 1296
X-ORACLE-DMS-ECID: id-string
X-ORACLE-DMS-ECID: id-string
X-Frame-Options: DENY
Service-URI: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/db11g-se
Vary: Accept-Encoding,User-Agent
Content-Language: en
Content-Type: application/json

    Response Body

    {
  "service_name": "db11g-se",
  "version": "11.2.0.4",
  "status": "Running",
  "description": "Example service instance",
  "identity_domain": "usexample",
  "creation_time": "Fri May 22 19:32:52 UTC 2015",
  "last_modified_time": "Fri May 22 19:32:52 UTC 2015",
  "created_by": "dbcsadmin",
  "service_uri": "https:\/\/dbaas.oraclecloud.com:443\/paas\/service\/dbcs\/api\/v1.1\/instances\/usexample\/db11g-se",
  "message": [
    "The Service [db11g-se] is restarting...",
    "The Service [db11g-se] has been restarted.",
    "    The Service [db11g-se] has been stopped.",
    "    The Service [db11g-se] has been started.",
    "        Started Virtual Machine db\/vm-1...",
    "        SSH access to VM(s) succeeded..."
  ],
  "job_start_date": "Fri Jun 26 19:06:03 GMT 2015",
  "job_status": "Succeeded",
  "job_operation": "restart-dbaas-service",
  "job_request_params": {
    "operationName": "restart-dbaas-service",
    "tenant": "usexample",
    "serviceInstance": "db11g-se",
    "serviceVersion": "11.2.0.4",
    "service-vm-name": "db\/vm-1",
    "computeResourceTimeout": "60",
    "serviceType": "dbaas",
    "lifecycleState": "RESTART",
    "namespace": "dbaas"
  }
}
    Back to Top