Jump to

• Request
• Response
• Examples

View Activity by Log Id

get

/paas/api/v1.1/activitylog/{identityDomainId}/message/{logId}

Returns information about an operation, including activity messages, by an activity log identifier.

Request

Path Parameters

• identityDomainId: string
  Identity domain ID for the Oracle Java Cloud Service account.
• logId: string
  Activity log ID of the operation.

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.

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 : jobid-response

Type: object

Show Source

• 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, and FAILED.
• summaryMessage(optional): string
  Operation type. For example, CREATE_SERVICE, SSH_PUBLIC_KEY_RESET, CONFIG_CHANGE, and so on.

{
    "properties":{
        "activityLogId":{
            "type":"integer",
            "description":"ID of the activity log."
        },
        "authDomain":{
            "type":"string",
            "description":"Identity domain ID for the Oracle Java Cloud Service account."
        },
        "authUser":{
            "type":"string",
            "description":"Name of the user account used to perform the operation on the Oracle Java Cloud Service instance."
        },
        "endDate":{
            "type":"string",
            "description":"Date and time the job ended."
        },
        "identityDomain":{
            "type":"string",
            "description":"Identity domain ID for the Oracle Java Cloud Service account."
        },
        "initiatedBy":{
            "type":"string",
            "description":"Value is <code>USER</code> when the job is initiated by a service end user."
        },
        "jobId":{
            "type":"integer",
            "description":"Job ID returned by the <code>Location</code> URI in the response header when the operation request was made."
        },
        "messages":{
            "type":"array",
            "description":"Groups activity messages.",
            "items":{
                "$ref":"#/definitions/job-messages"
            }
        },
        "operationId":{
            "type":"integer",
            "description":"ID of the operation."
        },
        "operationType":{
            "type":"string",
            "description":"Type of operation. For example, <code>CREATE_SERVICE</code>, <code>SSH_PUBLIC_KEY_RESET</code>, <code>CONFIG_CHANGE</code>, and so on."
        },
        "serviceId":{
            "type":"integer",
            "description":"ID of the Oracle Java Cloud Service instance."
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the Oracle Java Cloud Service instance."
        },
        "serviceType":{
            "type":"string",
            "description":"Cloud service type. Valid value is <code>jaas</code> for Oracle Java Cloud Service."
        },
        "startDate":{
            "type":"string",
            "description":"Date and time the job started."
        },
        "status":{
            "type":"string",
            "description":"Status of the job. Example status messages include: <code>RUNNING</code>, <code>SUCCEED</code>, and <code>FAILED</code>."
        },
        "summaryMessage":{
            "type":"string",
            "description":"Operation type. For example, <code>CREATE_SERVICE</code>, <code>SSH_PUBLIC_KEY_RESET</code>, <code>CONFIG_CHANGE</code>, and so on."
        }
    }
}

Nested Schema : messages

Type: array

Groups activity messages.

Show Source

• Array of: object job-messages

{
    "type":"array",
    "description":"Groups activity messages.",
    "items":{
        "$ref":"#/definitions/job-messages"
    }
}

Nested Schema : job-messages

Type: object

Show Source

• activityDate(optional): string
  Date and time the activity was logged.
• message(optional): string
  Details of the activity.

{
    "properties":{
        "activityDate":{
            "type":"string",
            "description":"Date and time the activity was logged."
        },
        "message":{
            "type":"string",
            "description":"Details of the activity."
        }
    }
}

Back to Top

Examples

The following example shows how to use the activity log ID to view information about an operation. 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/message/15453677"

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: 005QLc1JB936uHFpR05Eid0003kZ0000p2
x-oracle-dms-ecid: 005QLc1JB936uHFpR05Eid0003kZ0000p2
access-control-allow-origin: *
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Sun, 08 Apr 2018 17:56:16 GMT

Example of Response Body

The following example is the response returned in JSON format for a backup configuration change operation. Your response will differ, depending on the operation type and the log identifier you specified.

{
   "activityLogId":15453677,
   "serviceName":"ExampleInstance",
   "serviceType":"jaas",
   "identityDomain":"ExampleIdentityDomain",
   "serviceId":593380,
   "jobId":23921135,
   "startDate":"2018-03-31T17:58:48.058+0000",
   "endDate":"2018-03-31T17:58:48.885+0000",
   "status":"FAILED",
   "operationId":593380,
   "operationType":"CONFIG_CHANGE",
   "summaryMessage":"CONFIG_CHANGE",
   "authDomain":"ExampleIdentityDomain",
   "authUser":"username",
   "initiatedBy":"USER",
   "messages":[
      {
         "activityDate":"2018-03-31T17:58:48.058+0000",
         "message":"Activity Submitted"
      },
      {
         "activityDate":"2018-03-31T17:58:48.101+0000",
         "message":"Activity Started"
      },
      {
         "activityDate":"2018-03-31T17:58:48.833+0000",
         "message":"SM-BKP-5010: The supplied credentials or storage container for accessing Oracle Storage Cloud Service are incorrect. Response code returned: 400. Supply the correct credentials or storage container and try again. "
      },
      {
         "activityDate":"2018-03-31T17:58:48.885+0000",
         "message":"Activity Ended"
      }
   ]
}

Back to Top