View the Job Status of an Operation
/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/status/{requestName}/job/{jobId}
Request
-
identityDomainId: string
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.
-
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 stop, start or restart operation.
-
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
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.
Response
- application/json
200 Response
object
Response Body
-
created_by(optional):
string
The name of the Oracle Cloud user who created the instance.
-
creation_time(optional):
string
The instance creation date and time.
-
description(optional):
string
The instance description.
-
identity_domain(optional):
string
The identity domain hosting the instance.
-
job_operation(optional):
string
Current operation name in the job.
-
job_request_parameters(optional):
object job_request_parameters Object
Title:
job_request_parameters Object
-
job_start_date(optional):
string
The date and time when the job started.
-
job_status(optional):
string
Current status of the job; one of:
In Progress
,Succeded
,Failed
. -
last_modified_time(optional):
string
The date and time of last modification.
-
message(optional):
array message
Array of strings that contain details of operation progress.
-
service-uri(optional):
string
The resource URL for the instance.
-
service_name(optional):
string
The name of the service instance.
-
status(optional):
string
The instance status; one of:
Running
,In Progress
,Maintenance
,Stopped
,Terminating
, ,Configured
Failed
. -
version(optional):
string
The Oracle Database software version in use.
object
job_request_parameters Object
-
computeResourceTimeout(optional):
string
The value
60
. -
lifecycleState(optional):
string
The name of the life-cycle state change for operations that change the life-cycle state.
-
namespace(optional):
string
The value
dbaas
. -
operationName(optional):
string
The name of the operation.
-
service-vm-name(optional):
string
The name of the service instance's compute node.
-
serviceInstance(optional):
string
The name of the service instance.
-
serviceType(optional):
string
The value
dbaas
. -
serviceVersion(optional):
string
The Oracle Database software version in use.
-
tenant(optional):
string
The identity domain hosting the service instance.
array
-
Array of:
string
Title:
message Array Item
String containing one operation progress message.
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" } }