Return Parameters Displayed in Orchestrations v1

When you view an orchestration using the web console, you’ll see that the orchestration contains additional information about your instances, such as its status and the most recent start or stop time. This information contains return parameters that tell you about the current state of your instance. These return parameters are not part of the input that you provided in the JSON file that you uploaded.

You’ll also see that the orchestration includes certain optional parameters that you might not have specified in the JSON that you uploaded. These optional parameters are displayed either empty, or with a default value. For a description of optional input parameters, see Attributes in Orchestrations v1.

You might also notice that the sequence of objects is different from the sequence of objects in the JSON file that you uploaded. This happens because Compute Classic rearranges the objects according to a certain internal sequence. However, this has no impact on the values you provided or the way your orchestration works.

The following table shows the return parameters displayed for your instance when you view an orchestration using the web console.

Return Parameters Description
Top-level Parameters  
status

Shows the current status of the orchestration.

account

Shows the default account for your identity domain.

uri

Shows the complete URI of the orchestration.

info

The nested parameter errors shows which object in the orchestration has encountered an error. Empty if there are no errors.

status_timestamp

This information is generally displayed at the end of the orchestration JSON. It indicates the time that the current view of the orchestration was generated. This information shows only when the orchestration is running.

Oplan Parameters  
status

Shows the current status of the oplan.

info

If the orchestration has encountered an error, the nested parameter errors shows the errors. Empty if there are no errors.

status_timestamp

This information is generally displayed towards the end of the orchestration JSON. It indicates the time that the current view of the orchestration was generated. This information shows only when the orchestration is running.

Instance Parameters  
placement_requirements

Empty. This parameter is not used.

ip

If the instance is running, this parameter shows its private IP address. This information doesn’t show when an instance is not running.

state

If the orchestration is running, this parameter shows the current state of the instance. This information doesn’t show when an orchestration is stopped or if the instance couldn’t be created due to an error.

start_time

If the orchestration is running, this parameter shows the time the instance was created. This information doesn’t show when an orchestration is stopped or if the instance couldn’t be created due to an error.

error_reason

If the instance goes into an error state, this parameter shows the reason for the error. This information doesn’t show when an instance is not in an error state.