Jump to

• Request
• Response
• Examples

View the Status of a Stack Operation

get

/paas/api/v1.1/activitylog/{identityDomainId}/stack/job/{jobId}

Retrieve information about a specific job in Cloud Stack

Request

Path Parameters

• identityDomainId: string
  Name of the Oracle Cloud identity domain
• jobId: string
  ID of the operation to view

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : viewstackjobactivitylog-response

Type: object

The response body contains information about a specific job in Cloud Stack. A job includes a list of log messages.

Show Source

• activityLogId(optional): string
  ID of the activity log that this job belongs to
• authDomain(optional): string
  Name of the Oracle Cloud identity domain
• authUser(optional): string
  Name of the user who initiated the operation
• endDate(optional): string
  End date and time of the operation
• identityDomain(optional): string
  Name of the Oracle Cloud identity domain
• initiatedBy(optional): string
  Indicates whether this operation was initiated by a user or the system
• jobId(optional): string
  ID of the job
• messages(optional): array messages
• operationId(optional): string
  ID for the operation (the cloud stack ID)
• operationType(optional): string
  Type of operation
• serviceId(optional): string
  ID for the cloud stack
• serviceName(optional): string
  Name of the cloud stack
• serviceType(optional): string
  Type of service (cloudstack)
• startDate(optional): string
  Start date and time of the operation
• status(optional): string
  Status of the operation
• summaryMessage(optional): string
  Summary of the operation

{
    "description":"The response body contains information about a specific job in Cloud Stack. A job includes a list of log messages.",
    "properties":{
        "activityLogId":{
            "type":"string",
            "description":"ID of the activity log that this job belongs to"
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the cloud stack"
        },
        "serviceType":{
            "type":"string",
            "description":"Type of service (cloudstack)"
        },
        "identityDomain":{
            "type":"string",
            "description":"Name of the Oracle Cloud identity domain"
        },
        "serviceId":{
            "type":"string",
            "description":"ID for the cloud stack"
        },
        "jobId":{
            "type":"string",
            "description":"ID of the job"
        },
        "startDate":{
            "type":"string",
            "description":"Start date and time of the operation"
        },
        "endDate":{
            "type":"string",
            "description":"End date and time of the operation"
        },
        "status":{
            "type":"string",
            "description":"Status of the operation"
        },
        "operationId":{
            "type":"string",
            "description":"ID for the operation (the cloud stack ID)"
        },
        "operationType":{
            "type":"string",
            "description":"Type of operation"
        },
        "summaryMessage":{
            "type":"string",
            "description":"Summary of the operation"
        },
        "authDomain":{
            "type":"string",
            "description":"Name of the Oracle Cloud identity domain"
        },
        "authUser":{
            "type":"string",
            "description":"Name of the user who initiated the operation"
        },
        "initiatedBy":{
            "type":"string",
            "description":"Indicates whether this operation was initiated by a user or the system"
        },
        "messages":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/viewactivitymessage-response"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

• Array of: object viewactivitymessage-response
  The response body contains information about a message in the activity log.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/viewactivitymessage-response"
    }
}

Nested Schema : viewactivitymessage-response

Type: object

The response body contains information about a message in the activity log.

Show Source

• activityDate(optional): string
  Date and time of the message
• message(optional): string
  Message text

{
    "description":"The response body contains information about a message in the activity log.",
    "properties":{
        "activityDate":{
            "type":"string",
            "description":"Date and time of the message"
        },
        "message":{
            "type":"string",
            "description":"Message text"
        }
    }
}

400 Response

Bad Request. Returned if there is bad input.

404 Response

Not Found. Returned if the activity log does not exist.

Back to Top

Examples

The following example shows how to view a specific job in Oracle Cloud Stack by submitting a GET request to the activity log endpoint and providing the job ID number.

cURL Command

curl -i -X GET \
-u yourUsername:yourPassword \
-H "X-ID-TENANT-NAME:MyIdentityDomain" \
https://psm.us.oraclecloud.com/paas/api/v1.1/activitylog/MyIdentityDomain/stack/job/80045

Note: This example uses the URL prefix for the United States. For information about the URL prefixes for other regions of the world, see Send Requests.

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Thu, 25 Aug 2016 18:50:14 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following shows an example of the response body in JSON format. The job includes log messages related to creation of a cloud stack.

{
  "activityLogId":36004,
  "serviceName":"MyStack",
  "serviceType":"cloudstack",
  "identityDomain":"MyIdentityDomain",
  "serviceId":1701,
  "jobId":80045,
  "startDate":"2016-07-25T22:51:16.143+0000",
  "status":"NEW",
  "operationId":1701,
  "operationType":"CREATE_SERVICE",
  "summaryMessage":"CREATE_SERVICE",
  "authDomain":"MyIdentityDomain",
  "authUser":"yourUsername",
  "initiatedBy":"USER",
  "messages": [
    {
      "activityDate":"2016-07-25T22:51:16.143+0000",
      "message":"Stack provisioning request accepted"
    },
    {
      "activityDate":"2016-07-25T22:51:16.147+0000",
      "message":"Initializing stack MyStack"
    },
    {
      "activityDate":"2016-07-25T22:51:16.175+0000",
      "message":"Preparing to create service MyStack"
    },
    {
      "activityDate":"2016-07-25T22:52:51.217+0000",
      "message":"Successfully created ACCS Service MyStack-App"
    },
    {
      "activityDate":"2016-07-25T22:52:51.714+0000",
      "message":"Completed configuring stack MyStack"
    }
  ]
}

Back to Top