List All Activity
/paas/api/v1.1/activitylog/{identityDomainId}/filter
Use one or more optional query parameters to filter the result. To pass a list of values for a parameter, repeat the parameter in the expression. For example: ?status=RUNNING&status=FAILED
By default the result is presented in descending order by startDate
.
Request
-
identityDomainId: string
Identity domain ID for the Oracle Java Cloud Service account.
-
fromStartDate(optional): string
Gets all activity created after a specific date.
Supported date formats are
yyyy-MM-dd
,yyyy-MM-dd'T'HH:mm:ss.SSSZ
,yyyy-MM-dd HH:mm:ss
Can be used along with
toStartDate
to get activity created within a date range. -
operationType(optional): string
Gets all activity for a specific type of operation. For example:
CREATE_SERVICE
,DELETE_SERVICE
,SCALE_OUT
,STOP_SERVICE
,START_SERVICE
,ADD_SERVICE_RESOURCE
,BACKUP
and so on.Repeat the parameter to pass a list of values.
-
orderBy(optional): string
Sorts the results by a field name, in ascending or descending order.
Use the format
field_name:sort_order
. Valid values for the sort order are:asc
ordesc
.For example:
?orderBy=serviceName:asc
-
serviceName(optional): string
Gets all activity for a specific service instance name.
-
status(optional): string
Gets all activity for a specific status. For example:
SUCCEED
,FAILED
,RUNNING
and so on.Repeat the parameter to pass a list of values.
-
toStartDate(optional): string
Gets all activity created before a specific date.
Supported date formats are
yyyy-MM-dd
,yyyy-MM-dd'T'HH:mm:ss.SSSZ
,yyyy-MM-dd HH:mm:ss
Can be used along with
fromStartDate
to get activity created within a date range.
-
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
- application/json
200 Response
object
-
activityLogs(optional):
array activityLogs
Groups activity details.
-
totalCount(optional):
integer
Number of activity objects returned.
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.
object
-
activityDate(optional):
string
Date and time the activity was logged.
-
message(optional):
string
Details of the activity.
Examples
The following examples show how to use the activity log filter endpoint with one or more query parameters to list activity information. The examples use 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 Commands
curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" "https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/filter?serviceName=ExampleInstance" curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" "https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/filter?fromStartDate=2018-04-01" curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" "https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/filter?toStartDate=2018-04-01" curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" "https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/filter?fromStartDate=2018-04-05&toStartDate=2018-04-06" curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" "https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/filter?status=RUNNING" curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" "https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/filter?operationType=BACKUP" curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" "https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/filter?operationType=PRECHECK&operationType=DELETE_TEMPLATE" curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" "https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/filter?operationType=BACKUP&orderBy=serviceName:asc"
Example of Response Header
The following shows an example of the response header.
HTTP/1.0 200 Connection established
HTTP/2 200
server: Oracle-Application-Server-11g
strict-transport-security: max-age=31536000;includeSubDomains
content-language: en
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: 005QJ7cT8cG3z015Rvl3id0007SK0001cB
x-oracle-dms-ecid: 005QJ7cT8cG3z015Rvl3id0007SK0001cB
access-control-allow-origin: *
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Fri, 06 Apr 2018 18:05:58 GMT
content-length: 1390
Example of Response Body
The following example is the response returned in JSON format for a DELETE_TEMPLATE
operation. Your response will differ, depending on the query parameters you provided.
{
"activityLogs": [
{
"activityLogId": 4696021,
"serviceType": "cloudstack",
"identityDomain": "ExampleIdentityDomain",
"serviceId": 0,
"jobId": 0,
"startDate": "2018-03-02T16:01:59.834+0000",
"endDate": "2018-03-02T16:01:59.834+0000",
"status": "SUCCEED",
"operationId": 0,
"operationType": "DELETE_TEMPLATE",
"summaryMessage": "DELETE_TEMPLATE",
"authDomain": "ExampleIdentityDomain",
"authUser": "username",
"initiatedBy": "USER",
"resourceName": "MyJavaTemplate",
"resourceType": "TEMPLATE",
"resourceId": 0,
"messages": [
{
"activityDate": "2018-03-02T16:01:59.834+0000",
"message": "Template [MyJavaTemplate,null] deleted successfully"
}
]
},
...
{
"activityLogId": 4261671,
"serviceType": "cloudstack",
"identityDomain": "ExampleIdentityDomain",
"serviceId": 0,
"jobId": 0,
"startDate": "2018-02-13T20:49:39.450+0000",
"endDate": "2018-02-13T20:49:39.450+0000",
"status": "SUCCEED",
"operationId": 0,
"operationType": "DELETE_TEMPLATE",
"summaryMessage": "DELETE_TEMPLATE",
"authDomain": "ExampleIdentityDomain",
"authUser": "username",
"initiatedBy": "USER",
"resourceName": "My-Oracle-JCS-DBCS-Template",
"resourceType": "TEMPLATE",
"resourceId": 0,
"messages": [
{
"activityDate": "2018-02-13T20:49:39.450+0000",
"message": "Template [My-Oracle-JCS-DBCS-Template,null] deleted successfully"
}
]
}
],
"totalCount": 9
}