Jump to

• Request
• Response
• Examples

View the Status of an Operation

get

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

Returns the status of an operation on Exadata Cloud Service.

Request

Path Parameters

• identityDomainId: string

  The value depends on the type of Exadata Cloud Service account that is used to make the request:

  • For a Traditional Cloud Account, specify the Identity Domain Name that is associated with the service.

  • For a Cloud Account with Identity Cloud Service, specify the Identity Service Id that is associated with the service, which has the format idcs-letters-and-numbers.

• jobId: string
  The Job ID for the operation.
• requestName: string

  Name of the request for which you want to view status.

  Valid values include:

  • create: View the status for a create operation, as described in Create a Database Deployment.
  • delete: View the status of a delete operation, as described in Delete a Database Deployment.
  • control: View the status of a compute node lifecycle state control operation, as described in Stop, Start or Restart a Compute Node.

Header Parameters

• Authorization: string
  Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
• X-ID-TENANT-NAME: string

  The value depends on the type of Exadata Cloud Service account that is used to make the request:

  • For a Traditional Cloud Account, specify the Identity Domain Name that is associated with the service.

  • For a Cloud Account with Identity Cloud Service, specify the Identity Service Id that is associated with the service, which has the format idcs-letters-and-numbers.

  For more information, see Security, Authentication and Authorization.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK. See Status Codes for information about other possible HTTP status codes.

Body ()

Root Schema : jobstatus-response

Type: object

The response body contains information about the status of the operation.

Show Source

• created_by(optional): string
  Name of the Oracle Cloud user who created the database deployment.
• creation_time(optional): string
  The database deployment creation date and time.
• description(optional): string
  The database deployment description.
• identity_domain(optional): string
  The identity domain associated with the database deployment.
• job_operation(optional): string
  The operation name associated with the job.
• job_request_parameters(optional): object stopstart-postrequest
  The request body defines the details of the compute node lifecycle request. Bold indicates a required value.
• job_start_date(optional): string
  The date and time when the job started.
• job_status(optional): string

  Current status of the job.

  Values include: In Progress, Succeded, Failed.

• last_modified_time(optional): string
  The date and time of last modification.
• message(optional): string
  Details about the progress of the operation.
• service-uri(optional): string
  The resource URL for the database deployment.
• service_name(optional): string
  Name of the database deployment.
• status(optional): string

  The database deployment status.

  Values include: Running, In Progress, Maintenance, Stopped, Terminating, and Failed.

• version(optional): string
  The Oracle Database software version in use.

{
    "description":"The response body contains information about the status of the operation.",
    "properties":{
        "service_name":{
            "type":"string",
            "description":"Name of the database deployment."
        },
        "version":{
            "type":"string",
            "description":"The Oracle Database software version in use."
        },
        "status":{
            "type":"string",
            "description":"<p>The database deployment status.</p><p>Values include: <code>Running</code>, <code>In Progress</code>, <code>Maintenance</code>, <code>Stopped</code>, <code>Terminating</code>, and <code>Failed</code>.</p>"
        },
        "description":{
            "type":"string",
            "description":"The database deployment description."
        },
        "identity_domain":{
            "type":"string",
            "description":"The identity domain associated with the database deployment."
        },
        "creation_time":{
            "type":"string",
            "description":"The database deployment creation date and time."
        },
        "last_modified_time":{
            "type":"string",
            "description":"The date and time of last modification."
        },
        "created_by":{
            "type":"string",
            "description":"Name of the Oracle Cloud user who created the database deployment."
        },
        "service-uri":{
            "type":"string",
            "description":"The resource URL for the database deployment."
        },
        "message":{
            "type":"string",
            "description":"Details about the progress of the operation."
        },
        "job_start_date":{
            "type":"string",
            "description":"The date and time when the job started."
        },
        "job_status":{
            "type":"string",
            "description":"<p>Current status of the job.</p><p>Values include: <code>In Progress</code>, <code>Succeded</code>, <code>Failed</code>.</p>"
        },
        "job_operation":{
            "type":"string",
            "description":"The operation name associated with the job."
        },
        "job_request_parameters":{
            "$ref":"#/definitions/stopstart-postrequest"
        }
    }
}

Nested Schema : stopstart-postrequest

Type: object

The request body defines the details of the compute node lifecycle request. Bold indicates a required value.

Show Source

• lifecycleState(optional): string
  The operation being performed:

  • stop - Stop a running compute node.

  • start - Start a stopped compute node.

  • restart - Restart a running compute node.

• lifecycleTimeout(optional): string

  The operation timeout for the request.

  The range of valid values is 1 to 300 minutes.

  The default is 60 minutes.

• vmName(optional): string
  Name of the compute node being acted on.

{
    "description":"The request body defines the details of the compute node lifecycle request. <b>Bold</b> indicates a required value.",
    "properties":{
        "lifecycleState":{
            "type":"string",
            "description":"The operation being performed:<ul><li><p><code>stop</code> - Stop a running compute node.</p></li><li><p><code>start</code> - Start a stopped compute node.</p></li><li><p><code>restart</code> - Restart a running compute node.</p></li></ul>"
        },
        "lifecycleTimeout":{
            "type":"string",
            "description":"<p>The operation timeout for the request.</p><p>The range of valid values is <code>1</code> to <code>300</code> minutes.</p><p>The default is <code>60</code> minutes.</p>"
        },
        "vmName":{
            "type":"string",
            "description":"Name of the compute node being acted on."
        }
    }
}

Back to Top

Examples

The following example shows how to view status information about a request to restart a compute node associated with Exadata Cloud Service using cURL.

In this example, the identity domain is usexample and the Oracle Cloud user name and password are serviceadmin and Pa55_word. The job number for the restart request is 12209188.

cURL Command

curl -i -X GET --cacert ~/cacert.pem -u serviceadmin:Pa55_word -H "X-ID-TENANT-NAME:usexample"  https://dbaas.oraclecloud.com/paas/service/dbcs/api/v1.1/instances/usexample/status/control/job/12209188

HTTP Status Code and Response Headers

HTTP/2.0 200
server: Oracle-Application-Server-11g
strict-transport-security: max-age=31536000;includeSubDomains
content-language: en
service-uri: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/db12c
access-control-allow-headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
access-control-allow-methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
x-oracle-dms-ecid: 005KA79B7Bp6uHFpR05Eid0007dd0002LB
x-oracle-dms-ecid: 005KA79B7Bp6uHFpR05Eid0007dd0002LB
access-control-allow-origin: *
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Mon, 29 May 2017 04:04:38 GMT
content-length: 1413

Response Body

{
  "service_name": "db12c",
  "version": "12.1.0.2",
  "status": "Running",
  "description": "Example Exadata Cloud Service database deployment created using REST API",
  "identity_domain": "usexample",
  "creation_time": "2017-05-29T01:48:26.563+0000",
  "last_modified_time": "2017-05-29T01:48:26.543+0000",
  "created_by": "serviceadmin",
  "sm_plugin_version": "17.2.3-539",
  "tools_version": "17.2.3-539",
  "backup_supported_version": "16.1.5",
  "service_uri": "https:\/\/dbaas.oraclecloud.com:443\/paas\/service\/dbcs\/api\/v1.1\/instances\/usexample\/db12c",
  "database_id": "0",
  "message": [
    "VM [node01.us2.oraclecloud.com] of Database Cloud Service [db12c] is being stopped...",
    "VM [node01.us2.oraclecloud.com] of Database Cloud Service [usexample::db12c] has been stopped."
  ],
  "job_start_date": "Mon May 29 04:01:17 GMT 2017",
  "job_end_date": "Mon May 29 04:04:18 GMT 2017",
  "job_status": "Succeeded",
  "job_operation": "stop-exadata-service",
  "job_request_params": {
    "exa-unit-id": "161",
    "tenant": "usexample",
    "operationName": "stop-exadata-service",
    "serviceInstance": "db12c",
    "serviceVersion": "12.1.0.2",
    "service-vm-name": "node01.us2.oraclecloud.com",
    "computeResourceTimeout": "60",
    "serviceType": "dbaas",
    "lifecycleState": "STOP",
    "vmName": "node01.us2.oraclecloud.com",
    "namespace": "dbaas"
  }
}

Back to Top