View Action Execution Status

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameView Action Execution Status
Description
Allowed Role(s)WM_USER
MethodGET
URI
  • v1/executions/status

  • v1/executions/status?id=actionId&resourceType=VIRTUAL_MACHINE&logs=true

  • v1/executions/actionExecutionId/status?logs=true
  • cloudcenter-ccm-backend/api/v1/executions/status
  • cloudcenter-ccm-backend/api/v1/executions/status?id=actionId&resourceType=VIRTUAL_MACHINE&logs=true
  • cloudcenter-ccm-backend/api/v1/executions/actionExecutionId/status?logs=true
Sample Request
curl -k -X GET -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/executions/status?actionId=20&logs=false"
curl -k -X GET -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/executions/status?actionId=20&logs=false"
Release

Introduced in CloudCenter 4.8.0

Modified in CloudCenter Suite 5.0.0

Notes
  • Only resource owners and users with WRITE perms can view all the fields for this resource.
  • Other users can only view common fields like name, description, and so forth. See Permission Control for additional context.
  • API-specific notes:

      • resourceType = VIRTUAL_MACHINE.

      • ids = Unique IDs for the managed VM, deployment, or application profile.

      • cloudResourceIDs = The unmanaged VM ID

Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

  • action: get.executions.status

  • action: get.executions.status
    actionparam:
    id=actionId&resourceType=VIRTUAL_MACHINE&logs=true

  • action: get.executions.actionExecutionId.status
    actionparamlogs=true

See the Enterprise Service Bus (ESB) section for additional context.

Not applicable

Example 1 – Returns All Executions Based on the Requested Action ID

Response

[
  {
    "actionExecutionId":806,
    "actionId":20,
    "actionName":"Mark Favourite",
    "resourceType":"DEPLOYMENT",
    "userId":2,
    "userName":"Cliqr Admin",
    "status":"SUCCEEDED",
    "startTime":"2018-05-10 11:47:14.546",
    "endTime":"2018-05-10 11:47:22.873",
    "acknowledgedByUser":false,
    "executionResources":[
      {
        "resourceId":"670",
        "resourceName":"wp_lb_mo",
        "status":"SUCCEEDED",
        "result":null,
        "logs":[]
      }
    ]
  }
]

Example 2 – Returns IDs and Resource Types

curl -k -X GET -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/executions/status?id=45&resourceType=VIRTUAL_MACHINE&logs=true"

Response

[
  
  {
    "actionExecutionId":4,
    "actionId":5,
    "actionName":"Create And Attach Volume",
    "resourceType":"VIRTUAL_MACHINE",
    "userId":2,
    "userName":"Cliqr Admin",
    "status":"FAILED",
    "startTime":"2017-11-28 23:09:43.266",
    "endTime":"2017-11-28 23:10:43.117",
    "acknowledgedByUser":true,
    "executionResources":[ ]
  },
  {
    "actionExecutionId":5,
    "actionId":5,
    "actionName":"Create And Attach Volume",
    "resourceType":"VIRTUAL_MACHINE",
    "userId":2,
    "userName":"Cliqr Admin",
    "status":"FAILED",
    "startTime":"2017-11-28 23:20:31.076",
    "endTime":"2017-11-28 23:20:43.173",
    "acknowledgedByUser":true,
    "executionResources":[ ]
  },
  {
    ...
  }
]

Example 3 – Returns Status and Logs for the Execution

curl -k -X GET -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/executions/1163/status?logs=true"

Response

{
  "actionExecutionId":1163,
  "actionId":45,
  "actionName":"Install AppD Agent",
  "resourceType":"VIRTUAL_MACHINE",
  "userId":2,
  "userName":"Cliqr Admin",
  "status":"SUCCEEDED",
  "startTime":"2018-09-09 10:31:52.143",
  "endTime":"",
  "acknowledgedByUser":false,
  "executionResources":[
    {
      "resourceId":"60686353",
      "resourceName":"",
      "status":"SUCCEEDED",
      "result":"hello",
      "logs":[
        {
          "message":"Execution started",
          "status":"STARTED",
          "timestamp":"2018-09-09 10:31:52.366"
        },
        {
          "message":"Success",
          "status":"COMPLETED",
          "timestamp":"2018-09-09 10:31:52.438"
        }
      ]
    }
  ]
}

Request Attributes

actionExecutionId
  • Description: The ID is generated automatically by the CloudCenter platform for each action execution. 

  • Type: String

actionId
  • Description: The Managed VM ID or jobId or Application Profile ID.

  • Type: Long

actionName
  • Type: Enumeration

resourceType (type)
  • Description: The data type for a CloudCenter Resource.

  • Type: Enumeration

    EnumerationCategory
    VIRTUAL_MACHINE

    Identifies this resource to be a managed or unmanaged VM

    VmResourceType
    • Description: The type of Virtual Machine (VM) from the context of the CloudCenter platform.

    • Type: String

      StringCategory
      DEPLOYMENT_VMIdentifies this as a VM that was deployed by the CloudCenter platform. See the Managed VMs section for the relevant release for additional context.
      IMPORTED_VMIdentifies this as a VM that was discovered by the CloudCenter platform. See the Unanaged VMs section for the relevant release for additional context.

    DEPLOYMENTIdentifies this resource to be a deployment
    APPLICATION_PROFILEIdentifies this resource to be an application profile

    SERVICE

    Identifies this resource to be an application service

    CLOUD_REGION

    Identifies this resource to be a supported cloud region

As a request parameter, resourceType=VIRTUAL_MACHINE is the only available option.

logs
  • Description: Identifies if logs should be included for the identified resource.
  • Type: Boolean
    • true = Logs are listed for the identified resource.
    • false = Default. Logs are not listed for the identified resource.

Response Attributes

actionExecutionId
  • Description: The ID is generated automatically by the CloudCenter platform for each action execution. 

  • Type: String

actionId
  • Description: The Managed VM ID or jobId or Application Profile ID.

  • Type: Long

actionName
  • Type: Enumeration

resourceType (type)
  • Description: The data type for a CloudCenter Resource.

  • Type: Enumeration

    EnumerationCategory
    VIRTUAL_MACHINE

    Identifies this resource to be a managed or unmanaged VM

    VmResourceType
    • Description: The type of Virtual Machine (VM) from the context of the CloudCenter platform.

    • Type: String

      StringCategory
      DEPLOYMENT_VMIdentifies this as a VM that was deployed by the CloudCenter platform. See the Managed VMs section for the relevant release for additional context.
      IMPORTED_VMIdentifies this as a VM that was discovered by the CloudCenter platform. See the Unanaged VMs section for the relevant release for additional context.

    DEPLOYMENTIdentifies this resource to be a deployment
    APPLICATION_PROFILEIdentifies this resource to be an application profile

    SERVICE

    Identifies this resource to be an application service

    CLOUD_REGION

    Identifies this resource to be a supported cloud region

userId
  • Description: Unique, system-generated identifier for a user
  • Type: String

username
  • Description: Unique, CloudCenter-generated name reference for this user.
  • Type: String

status
  • Description: The action status for this resource.

  • Type: Enumeration

    EnumerationDescription
    SUBMITTEDThe CloudCenter platform has received the task request and started to process it but the action is not yet completed.
    SCHEDULEDThe task is configured to start at some point in the future.
    STARTEDThe task has started successfully.
    IN_PROGRESSThe task is in the process of being executed.
    PENDINGThe task is still awaiting completion due to the completion of another task.
    CANCELEDThe task was terminated after it was started.
    APPROVEDThe task was approved by the authorized approver(s).
    REJECTEDThe task was rejected by the authorized approver(s).
    COMPLETEDThe task was completed successfully.
    ERRORThe task was aborted due to an error.
    TIMEOUTThe task did not complete within the allocated time.

startTime

endTime

acknowledgedByUser
  • Description: Identifies if the action is to be acknowledged by the user.
  • Type: Boolean
    • true = The action must be acknowledged.
    • false = Default. The action need not be acknowledged.

executionResources
  • Description: CloudCenter resources that are available for this execution.
  • Type: Sequence of resource details

    resourceId
    • Description: Unique identifier for a CloudCenter Resource managed by ACLs. This ID is generated automatically by the CloudCenter platform when the resource is created.  
    • Type: String

    resourceName
    • Description: The name of the resource. 

    • Type: String

    status (nodeStatus)
    • Description: The node status for this resource. 

    • Type: Enumeration. See the Deployment and VM States > VM (Node) States section for the relevant release for additional details.

     result 
    • Type: String
     logs 
    • Description: Lists logs for the identified VM.
    • Type: Sequence of log details

      message
      • Description: Identifies the resulting progress message for the workflow activity execution.

      • Type: String

      status
      • Description: The action status for this resource.

      • Type: Enumeration

        EnumerationDescription
        SUBMITTEDThe CloudCenter platform has received the task request and started to process it but the action is not yet completed.
        SCHEDULEDThe task is configured to start at some point in the future.
        STARTEDThe task has started successfully.
        IN_PROGRESSThe task is in the process of being executed.
        PENDINGThe task is still awaiting completion due to the completion of another task.
        CANCELEDThe task was terminated after it was started.
        APPROVEDThe task was approved by the authorized approver(s).
        REJECTEDThe task was rejected by the authorized approver(s).
        COMPLETEDThe task was completed successfully.
        ERRORThe task was aborted due to an error.
        TIMEOUTThe task did not complete within the allocated time.

       timestamp 
      • Description: The CloudCenter API date and time values are formatted in Unix time to the millisecond level.
      • Type: String

  • No labels
© 2017-2019 Cisco Systems, Inc. All rights reserved