ParkableEntityApiDTO
Description
Parkable Entity
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
-
- environmentType
-
-
type: string
-
example: ONPREM
-
description: On-Prem environment type
-
enum: ['HYBRID', 'CLOUD', 'ONPREM', 'UNKNOWN']
-
- accountOID
-
-
type: integer
-
format: int64
-
example: 74613608411667
-
description: Unique ID of the account
-
- accountName
-
-
type: string
-
example: dev-account
-
description: Display name of the account
-
- provider
-
-
type: string
-
example: AWS
-
description: Name of the cloud provider
-
enum: ['AWS', 'AZURE', 'GCP', 'HYBRID', 'UNKNOWN']
-
- state
-
-
type: string
-
example: STOPPED
-
description: Last known state of the entity
-
enum: ['RUNNING', 'STOPPED', 'SUSPENDED', 'MAINTENANCE', 'FAILOVER', 'UNKNOWN', 'STARTING', 'STOPPING']
-
- parkable
-
-
type: boolean
-
example: True
-
description: Signifies whether the entity can be parked. [DEPRECATED - EOL: 8.15.1 - Use: restrictions]
-
- entityType
-
-
type: string
-
example: COMPUTE
-
description: Type of the entity
-
enum: ['VirtualMachine', 'DatabaseServer', 'Database', 'VirtualMachineSpec']
-
- regionOID
-
-
type: integer
-
format: int64
-
example: 74613608411668
-
description: Unique ID of the region, the entity belongs to
-
- regionName
-
-
type: string
-
example: us-east-1
-
description: Name of the region
-
- instanceType
-
-
type: string
-
example: t3.micro
-
description: Type of the instance
-
- targetOID
-
-
type: integer
-
format: int64
-
example: 746136084116679
-
description: Unique ID of the target
-
- datacenterName
-
-
type: string
-
example: VC1
-
description: Display name of the Data Center
-
- cost
-
-
type: number
-
format: double
-
example: 10.24
-
description: On demand hourly cost of the entity
-
- tags
-
-
type: array
-
description: List of tags attached to the entity
-
-
reference: TagApiDTO
-
-
- schedules
-
-
type: array
-
description: List of schedules attached to the entity
-
-
reference: ParkableEntityScheduleApiDTO
-
-
- groups
-
-
type: array
-
description: List of the Groups attached to the entity
-
-
reference: ParkableEntityGroupApiDTO
-
-
- guestOSName
-
-
type: string
-
example: Linux
-
description: Guest OS Name of the entity
-
- restrictions
-
-
type: array
-
description: List of the restrictions placed on the entity
-
-
reference: ParkableEntityRestrictionApiDTO
-
-
- controlledBy
-
-
type: integer
-
format: int64
-
example: 74613608411668
-
description: Unique ID of the entity that this entity is controlled by. For example, if this is a Virtual Machine that is part of a scale group, this would be the ID of the scale group
-
- smartParkingRecommendation
-
-
description: [BETA]: Smart Parking Schedule Recommendation for the entity
-
- schedulePausedUntil
-
-
type: integer
-
format: int64
-
example: 1673273639
-
description: The time until which the schedule is paused only applicable if entity has parking schedule, in epoch time format
-
- cloudServiceName
-
-
type: string
-
description: Cloud service name is the resource bought from the cloud service provider
-
enum: ['AMAZON_RDS', 'AMAZON_EC2', 'AMAZON_EC2_AUTO_SCALING', 'AZURE_APP_SERVICE', 'AZURE_COSMOS_DB', 'AZURE_DISK_STORAGE', 'AZURE_SQL_DATABASE', 'AZURE_SQL_MANAGED_INSTANCE', 'AZURE_SYNAPSE_SQL_POOL', 'AZURE_VIRTUAL_MACHINES', 'AZURE_VIRTUAL_MACHINE_SCALE_SETS', 'GCP_DISK_STORAGE', 'GCP_VIRTUAL_MACHINES']
-
- customInstanceType
-
-
type: string
-
example: n2d-custom-2-1024
-
description: The entity's custom instance type. Similar to instanceType but provides customization details about the type of instance the workload is based on
-