ActionApiDTO

Description

Model to describe an Action

Optional Parameters

uuid

  • type: string

displayName

  • type: string

  • description: A user readable name of the api object. Cannot be blank. The UTF-8 encoding must be at most 255 bytes.

className

  • type: string

actionImpactID

  • type: integer

  • format: int64

  • description: The ID for the action, which will persist across restarts

marketID

  • type: integer

  • format: int64

  • description: The ID of the market for which the action was generated

createTime

  • type: string

  • description: Creation time

updateTime

  • type: string

  • description: Update time

clearTime

  • type: string

  • description: Execution time

actionType

  • type: string

  • description: Type

  • enum: ['START', 'MOVE', 'SCALE', 'ALLOCATE', 'SUSPEND', 'PROVISION', 'RECONFIGURE', 'RESIZE', 'DELETE', 'RIGHT_SIZE', 'BUY_RI']

actionState

  • type: string

  • description: Action State.

  • enum: ['ACCEPTED', 'REJECTED', 'PRE_IN_PROGRESS', 'POST_IN_PROGRESS', 'IN_PROGRESS', 'SUCCEEDED', 'FAILED', 'DISABLED', 'QUEUED', 'CLEARED', 'ACCOUNTING', 'READY', 'FAILING', 'BEFORE_EXEC', 'IN_PROGRESS_NON_CRITICAL']

actionMode

  • type: string

  • description: Action Mode

  • enum: ['DISABLED', 'RECOMMEND', 'EXTERNAL_APPROVAL', 'MANUAL', 'AUTOMATIC', 'COLLECTION']

userName

  • type: string

  • description: Username of the user that accepted the action [DEPRECATED - Use: userInfo.userName in executionStatus.executorInfo]

details

  • type: string

  • description: A user-readable string describing the action

importance

  • type: number

  • format: float

  • description: Numeric value that describes the priority of the action

target

  • description: Target entity for an action. For example, the VM in a Resize Action, or the host for a VM move

  • reference: ServiceEntityApiDTO

currentEntity

  • description: Current entity, such as the current host that a VM resides on for a VM move action

  • reference: ServiceEntityApiDTO

newEntity

  • description: Destination entity, such as the host that a VM will move to for a VM move action

  • reference: ServiceEntityApiDTO

currentValue

  • type: string

  • description: Current value of a property, for example vMEM for a VM resize action

newValue

  • type: string

  • description: Calculated value to resize to, such as vMEM for a VM resize action

valueUnits

  • type: string

  • description: Units of the currentValue and newValue, such as KB for a VM vMEM resize action

resizeAttribute

  • type: string

  • description: The commodity attribute to be resized

  • enum: ['CAPACITY', 'LIMIT', 'RESERVATION']

template

  • description: Template used for the action, such as in a Cloud entity provision or move action

  • reference: TemplateApiDTO

risk
prerequisites

  • type: array

  • description: Description(s) of any prerequisite(s) that must occur before execution is possible. If this field is populated, the action would otherwise be executable but has been blocked by this prerequisite, and is displayed accordingly. If this field is not populated, no prerequisite has caused the action mode to be modified, and the action is displayed as normal.

    • type: string

prioritizedAutomationOpportunities

  • type: array

  • description: The Action is generated using the 'Prioritze Automation' setting, indicating that it is possible to have more savings if these opportunities are satisfied

    • type: string

stats

  • type: array

  • description: Statistics, such as Mem, vCPU, costPrice

progress

  • type: integer

  • format: int32

  • description: Moved the 'progress' percentage value inside 'executionStatus', available when action detail level is 'EXECUTION' - [DEPRECATED - Use: executionStatus.progress]

currentLocation

  • description: The region (DataCenter) where the current service entity is located, for cloud migration actions

  • reference: DiscoveredEntityApiDTO

newLocation

  • description: The region, represented as a DataCenter entity, where the target service entity will be located for cloud migration actions

  • reference: DiscoveredEntityApiDTO

virtualDisks

  • type: array

  • description: Virtual Disk used for the action, for example in a storage move

policy

  • description: The policy associated with the action

  • reference: PolicyApiDTO

relatedSettingsPolicies

  • type: array

  • description: The related settings policies associated with the action

actionSchedule
compoundActions

  • type: array

  • description: Property for compound move actions

reservedInstance
reservedInstancePlatform

  • type: string

  • description: The platform of the recommended RI if the action has a supersaving

externalActionName

  • type: string

  • description: The name under which this action appears in third-party software or external approval backend

externalActionUrl

  • type: string

  • description: URL to third-party software showing this action. Suitable for external action approval

executionStatus

  • description: Status details of the execution of the Action. Include percentage progress, error messages and execution times.

  • reference: ActionExecutionAuditApiDTO

executionCharacteristics
entityCharacteristics
source

  • type: string

  • description: Defines what generated this action.

  • enum: ['MARKET', 'PARKING']

relatedActionsCountByType

  • type: object

  • description: [BETA]: Map of related actions count by relationship type that have some relation to this Action

  • additionalProperties: {'type': 'integer', 'format': 'int32'}

actionID

  • type: integer

  • format: int64

  • description: Id of the action