ApmPlanInfo

edit

Information about a current, pending, or past plan

Properties

edit
attempt_end_time (string as date-time)
If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
attempt_start_time (string as date-time, required)
When this plan attempt (ie to apply the plan to the APM) started (ISO format in UTC)
healthy (boolean, required)
Either the plan ended successfully, or is not yet completed (and no errors have occurred)
plan (ApmPlan)
plan_attempt_id (string)
A UUID for each plan attempt
plan_attempt_log (array[ClusterPlanStepInfo], required)
plan_attempt_name (string)
A human readable name for each plan attempt, only populated when retrieving plan histories
plan_end_time (string as date-time)
If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
source (ChangeSourceInfo)
Information describing the source that facilitated the plans current state

Example

edit
{
   "attempt_end_time" : "2019-01-01T00:00:00Z",
   "attempt_start_time" : "2019-01-01T00:00:00Z",
   "healthy" : true,
   "plan" : {
      "apm" : {
         "docker_image" : "string",
         "system_settings" : {
            "debug_enabled" : "string",
            "elasticsearch_password" : "string",
            "elasticsearch_url" : "string",
            "elasticsearch_username" : "string",
            "kibana_url" : "string",
            "secret_token" : "string"
         },
         "user_settings_json" : {},
         "user_settings_override_json" : {},
         "user_settings_override_yaml" : "string",
         "user_settings_yaml" : "string",
         "version" : "string"
      },
      "cluster_topology" : [
         {
            "apm" : null,
            "instance_configuration_id" : "string",
            "size" : {
               "resource" : "string",
               "value" : 0
            },
            "zone_count" : 0
         }
      ],
      "transient" : {
         "plan_configuration" : {
            "calm_wait_time" : 0,
            "cluster_reboot" : "string",
            "extended_maintenance" : true,
            "move_allocators" : [
               {
                  "allocator_down" : true,
                  "from" : "string",
                  "to" : [
                     "string"
                  ]
               }
            ],
            "move_instances" : [
               {
                  "from" : "string",
                  "instance_down" : true,
                  "to" : [
                     "string"
                  ]
               }
            ],
            "preferred_allocators" : [
               "string"
            ],
            "reallocate_instances" : true,
            "timeout" : 0
         },
         "strategy" : {
            "grow_and_shrink" : {},
            "rolling" : {
               "allow_inline_resize" : true,
               "group_by" : "string",
               "shard_init_wait_time" : 0,
               "skip_synced_flush" : true
            },
            "rolling_grow_and_shrink" : {}
         }
      }
   },
   "plan_attempt_id" : "string",
   "plan_attempt_log" : [
      {
         "completed" : "2019-01-01T00:00:00Z",
         "duration_in_millis" : 0,
         "info_log" : [
            {
               "delta_in_millis" : 0,
               "message" : "string",
               "stage" : "string",
               "timestamp" : "2019-01-01T00:00:00Z"
            }
         ],
         "stage" : "string",
         "started" : "2019-01-01T00:00:00Z",
         "status" : "string",
         "step_id" : "string"
      }
   ],
   "plan_attempt_name" : "string",
   "plan_end_time" : "2019-01-01T00:00:00Z",
   "source" : {
      "action" : "string",
      "admin_id" : "string",
      "date" : "2019-01-01T00:00:00Z",
      "facilitator" : "string",
      "remote_addresses" : [
         "string"
      ],
      "user_id" : "string"
   }
}