Docs

Elastic Compute Service

orchestration plan

Creating orchestration plans

You can create orchestration plans to predefine O&M orchestration workflows for specific alert policies or event rules. When an alert or event occurs, the associated orchestration plan is automatically triggered, enabling automated O&M.

Prerequisite

If you want to use a custom template to create an orchestration plan, create the custom template first.

Procedure

In the left-side navigation pane, click "Maintenance & Monitoring > Orchestration".

In the top menu bar, select the region where your business is located.

On the "CloudOps Orchestration" page, click the "orchestration plan" tab.

Click the "Create orchestration plan" button. Configure the parameters described in the following table.

Parameter			Description	Sample value
Basic information
Name			Specify the name of the orchestration plan.	AutoInstanceRestartUponGPURisk
Role			Select a role with read and write permissions on your ECS resources. The default role is "CustomRoleForOOS," which integrates all permissions supported by Orchestration by default. This prevents permission issues during usage. You can also click the "Role" drop-down list to select a different role. The selected role must have permissions to perform operations on the corresponding resource. tip Click "View permissions required for the task" to view the permissions that are required by the role to execute orchestration plan. If the existing roles do not meet your business requirements, you can also click "Navigate to role management" to create a role.	Retain the default value.
Execution mode
Execution mode			The execution mode of tasks in the orchestration plan. Valid values: Execute immediately: After the tasks in the orchestration plan are created, they are executed immediately. Trigger execution: The orchestration plan is executed each time the orchestration plan is triggered by the specified event or alert.	Trigger execution
Trigger method			Select the trigger method. Valid values: Event trigger: When a specific event is generated for the target resource, the orchestration plan is automatically triggered, enabling automated O&M. Alert trigger: When the target resource generates an alert notification, the orchestration plan is automatically triggered, enabling automated O&M. tip This parameter is required only when you set "Mode" to "trigger execution".	Event trigger
Task step
Step creation type	Create from scratch	Add the steps you want to execute one by one in your desired order, using the preset task steps as a foundation. When the orchestration plan is executed, it performs automated O&M according to the sequence of these task steps. Click the "Create from scratch" button. Click the "Add step" button, and select the required step in the pop-up window. After you add a step, the system automatically assigns an ID to the step, making it easier to distinguish steps with the same feature. For example, the ID for a step that creates an ECS instance is id:437a. Click the "Add" button to complete the addition. Configure parameters for each step. You can configure input and output parameters for each step. Once a step is executed, the relevant information is displayed. For parameters supported by each step, see Summary of orchestration steps. Select the "Input" tab and configure the input parameters required for step execution. Parameter sources: Custom input: Select or enter parameter values. warning Certain steps only allow you to manually enter parameter values. The requirements specified for the steps in the console prevail. Select from previous tasks: Select the output parameter values of the previous steps in O&M orchestration as the input parameter values. Get from event object: The parameters triggered by the event are passed in the form of an Event. You can select a specific value from the JSON data of the event object. For example, you can use {{.Event.Details.data.InstanceId}} to obtain the instance ID from the event object. For the description of the event object structure, see Content of event alert callback requests. tip When you set "trigger method" to "Event trigger", you can select "Get from event object". Get from alert object: The parameters triggered by the alert are passed in the form of a Metric. You can select a specific value from the JSON data of the alert object. For example, you can use {{.Metric.Resources[0].id}} to obtain the instance ID from the alert object. For the description of the alert object structure, see Content of metric alert callback requests. tip When you set "trigger method" to "Alert trigger", you can select "Get from alert object". Select the "Output" tab to view information about the parameters returned after the current step is executed. (Optional) After you click the target step, click the icon to add more steps based on your business requirements. You can reorder the added steps by dragging them.	Create ECS instances
Step creation type		Select an existing template	You can create an orchestration plan based on an existing template (custom template). This enables the orchestration plan to automatically execute O&M tasks using your preset standardized O&M workflows. Click the "Select an existing template" button. Click the template drop-down list, select the target template, and view its basic information to verify whether the selected template meets your requirements. Configure the parameters based on the template you select. Learn more. tip The parameters vary depending on the selected template. The parameters displayed in the console prevail.	-

Click "Create" to complete the operation.

(Optional) You can click the plan name to view plan execution information. For more information, see Viewing orchestration plans.

Subsequent steps

After the orchestration plan is created, go to the CloudMonitor console to specify an event or alert trigger based on the trigger method you selected. Learn more.

Last updated: 2025.09.29 16:41:26