View the Status of an Operation by Job Id
get
/paas/api/v1.1/activitylog/{identityDomainId}/job/{jobId}
Returns information about an operation, including activity messages, by a job identifier.
Request
Path Parameters
-
identityDomainId: string
Identity domain ID for the Oracle Java Cloud Service account.
-
jobId: string
Job ID of the operation. This is returned in the response header of the operation request.
Header Parameters
-
Authorization: string
Base64 encoded user name and password separated by a colon or OAuth access token obtained from Oracle Identity Cloud Service. See Authenticate.
-
X-ID-TENANT-NAME: string
Identity domain ID for the Oracle Java Cloud Service account.
Response
Supported Media Types
- application/json
200 Response
OK. See Status Codes for information about other possible HTTP status codes.
Root Schema : jobid-response
Type:
Show Source
object
-
activityLogId(optional):
integer
ID of the activity log.
-
authDomain(optional):
string
Identity domain ID for the Oracle Java Cloud Service account.
-
authUser(optional):
string
Name of the user account used to perform the operation on the Oracle Java Cloud Service instance.
-
endDate(optional):
string
Date and time the job ended.
-
identityDomain(optional):
string
Identity domain ID for the Oracle Java Cloud Service account.
-
initiatedBy(optional):
string
Value is
USER
when the job is initiated by a service end user. -
jobId(optional):
integer
Job ID returned by the
Location
URI in the response header when the operation request was made. -
messages(optional):
array messages
Groups activity messages.
-
operationId(optional):
integer
ID of the operation.
-
operationType(optional):
string
Type of operation. For example,
CREATE_SERVICE
,SSH_PUBLIC_KEY_RESET
,CONFIG_CHANGE
, and so on. -
serviceId(optional):
integer
ID of the Oracle Java Cloud Service instance.
-
serviceName(optional):
string
Name of the Oracle Java Cloud Service instance.
-
serviceType(optional):
string
Cloud service type. Valid value is
jaas
for Oracle Java Cloud Service. -
startDate(optional):
string
Date and time the job started.
-
status(optional):
string
Status of the job. Example status messages include:
RUNNING
,SUCCEED
, andFAILED
. -
summaryMessage(optional):
string
Operation type. For example,
CREATE_SERVICE
,SSH_PUBLIC_KEY_RESET
,CONFIG_CHANGE
, and so on.
Nested Schema : job-messages
Type:
Show Source
object
-
activityDate(optional):
string
Date and time the activity was logged.
-
message(optional):
string
Details of the activity.
Examples
The following example shows how to use the job ID to view information about the operation being performed on the Oracle Java Cloud Service instance. The example uses cURL to submit a GET request on the REST resource.
Note: The command in this example uses the URL structure https://rest_server_url/resource-path
, where rest_server_url
is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.
cURL Command
curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" "https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/8722"
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK
Date: Tue, 19 Apr 2016 22:01:27 GMT
Transfer-Encoding: chunked
Content-Type: application/json
Example of Response Body
The following example is the response returned in JSON format for an SSH key operation. The response you get depends on the type of operation.
{
"activityLogId":135,
"serviceName":"ExampleInstance",
"serviceType":"jaas",
"identityDomain":"ExampleIdentityDomain",
"serviceId":8,
"jobId":8722,
"startDate":"2016-04-19T22:00:44.598+0000",
"endDate":"2016-04-19T22:08:30.655+0000",
"status":"SUCCEED",
"operationId":8,
"operationType":"SSH_PUBLIC_KEY_RESET",
"summaryMessage":"SSH_PUBLIC_KEY_RESET",
"authDomain":"ExampleIdentityDomain",
"authUser":"username",
"initiatedBy":"USER",
"messages":[
{
"activityDate":"2016-04-19T22:00:44.598+0000",
"message":"Activity Submitted"
},
{
"activityDate":"2016-04-19T22:00:45.139+0000",
"message":"Activity Started"
},
{
"activityDate":"2016-04-19T22:00:45.163+0000",
"message":"Resetting user ssh public key, new ssh public key: ssh-rsa ZYZYBZ3NzaC1yc2EAAAABJQAAAQEAix3Pt+tXlziLKWLyfY2tQUfsuHNvuL9SVeIJSmyqevv4n4AKxZ1wkgXdQmaN7iV2VlTJTf\/rpNAwXGwnSQr7GyGZv4udkyKqyBummnAnVNMPirCBr8scQPCfGB2rjVmfwgNK6TVtAD1t+uDhVIHEf9Jb05v940Abt9\/u5MFkxxoldQy6rRxgky3ZYstU72NOpiwmptYL5CDu3aPljZsx\/raKQACsU0qi3sCzLD76tK4sp+8BTkGBQIIJxa1zqdFHQzQmr2tcf8D6E4sauMqCpXGzLoxgrLMPtHfwkDsAaOc2VPVKafqHgKssbEFRrUclJHy3z9loYV6RzPABQpEEee== rsa-key-20166666"
},
{
"activityDate":"2016-04-19T22:04:05.792+0000",
"message":"Stopped all Compute resources..."
},
{
"activityDate":"2016-04-19T22:08:29.532+0000",
"message":"Started all Compute resources..."
},
{
"activityDate":"2016-04-19T22:08:30.633+0000",
"message":"Successful in resetting the user ssh key as: ssh-rsa ZYZYBZ3NzaC1yc2EAAAABJQAAAQEAix3Pt+tXlziLKWLyfY2tQUfsuHNvuL9SVeIJSmyqevv4n4AKxZ1wkgXdQmaN7iV2VlTJTf\/rpNAwXGwnSQr7GyGZv4udkyKqyBummnAnVNMPirCBr8scQPCfGB2rjVmfwgNK6TVtAD1t+uDhVIHEf9Jb05v940Abt9\/u5MFkxxoldQy6rRxgky3ZYstU72NOpiwmptYL5CDu3aPljZsx\/raKQACsU0qi3sCzLD76tK4sp+8BTkGBQIIJxa1zqdFHQzQmr2tcf8D6E4sauMqCpXGzLoxgrLMPtHfwkDsAaOc2VPVKafqHgKssbEFRrUclJHy3z9loYV6RzPABQpEEee== rsa-key-20166666"
},
{
"activityDate":"2016-04-19T22:08:30.655+0000",
"message":"Activity Ended"
}]
}