View Status of an Add SSH Key Job
/paas/api/v1.1/activitylog/{identityDomainId}/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 of the 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
-
activityLogId(optional):
integer
ID of the activity log.
-
authDomain(optional):
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.
-
authUser(optional):
string
Name of the Oracle Cloud user that initiated the add operation.
-
endDate(optional):
string
Date and time the job ended.
-
identityDomain(optional):
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.
-
initiatedBy(optional):
string
The value
USER
. -
jobId(optional):
integer
Job ID returned in the
Location
header when the Add SSH Key request was made. -
messages(optional):
array messages Array
Title:
messages Array
Array of JSON objects, with one element for each message reported during the job. -
operationId(optional):
integer
ID of the operation.
-
operationType(optional):
string
The value
SSH_PUBLIC_KEY_RESET
. -
serviceId(optional):
integer
ID of the Database Classic Cloud Service instance.
-
serviceName(optional):
string
Name of the Database Classic Cloud Service instance.
-
serviceType(optional):
string
The value
dbaas
. -
startDate(optional):
string
Date and time the job started.
-
status(optional):
string
Status of the job. Valid statuses include
RUNNING
,SUCCEED
andFAILED
. -
summaryMessage(optional):
string
The value
SSH_PUBLIC_KEY_RESET
.
array
messages Array
-
Array of:
object messages Array Item
Title:
messages Array Item
object
messages Array Item
-
activityDate(optional):
string
Date and time the activity was logged.
-
message(optional):
string
Details of the activity.
Examples
The following example shows how to view status information about a request to add an SSH public key by submitting a GET request on the REST endpoint 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
.
cURL Command
$ curl --include --request GET \
--user dbcsadmin:password \
--header "X-ID-TENANT-NAME:usexample" \
https://dbaas.oraclecloud.com/paas/api/v1.1/activitylog/usexample/job/5806492
HTTP Status Code and Response Headers
HTTP/1.1 200 OK Date: date-and-time-stamp Server: Oracle-Application-Server-11g Content-Length: 1670 X-ORACLE-DMS-ECID: id-string X-ORACLE-DMS-ECID: id-string X-Frame-Options: DENY Vary: Accept-Encoding,User-Agent Content-Language: en Content-Type: application/json
Response Body
{ "activityLogId":3643077, "serviceName":"db12c-xp-si2", "serviceType":"dbaas", "identityDomain":"usexample", "serviceId":141969, "jobId":5806492, "startDate":"2016-07-21T23:37:16.652+0000", "endDate":"2016-07-21T23:37:30.258+0000", "status":"SUCCEED", "operationId":141969, "operationType":"SSH_PUBLIC_KEY_RESET", "summaryMessage":"SSH_PUBLIC_KEY_RESET", "authDomain":"usexample", "authUser":"dbcsadmin", "initiatedBy":"USER", "messages":[ { "activityDate":"2016-07-21T23:37:16.652+0000", "message":"Activity Submitted" }, { "activityDate":"2016-07-21T23:37:16.729+0000", "message":"Activity Started" }, { "activityDate":"2016-07-21T23:37:16.746+0000", "message":"Resetting user ssh public key,\n new ssh public key: public-key-value" }, { "activityDate":"2016-07-21T23:37:30.237+0000", "message":"Successful in resetting the user ssh key as: public-key-value" }, { "activityDate":"2016-07-21T23:37:30.258+0000", "message":"Activity Ended" } ] }