ALIYUN::OOS::Execution - Resource Orchestration Service - Centro de documentación de Alibaba Cloud

ALIYUN::OOS::Execution inicia una ejecución.

Sintaxis

{
  "Type": "ALIYUN::OOS::Execution",
  "Properties": {
    "ResourceOptions": Map,
    "Parameters": Map,
    "Tags": Map,
    "TemplateName": String,
    "ParentExecutionId": String,
    "SafetyCheck": String,
    "Mode": String,
    "TemplateVersion": String,
    "ResourceGroupId": String,
    "LoopMode": String,
    "Description": String,
    "TemplateContent": String,
    "TemplateURL": String
  }
}

Propiedades

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricciones
ResourceOptions	Map	No	No	Para obtener más información, consulte ResourceOptions properties.	Para obtener más información, consulte the ResourceOptions properties.
Parameters	Map	No	No	Ejemplo: `{"Status": "Running"}`. Valor predeterminado: {}。	Ejemplo: `{"Status": "Running"}`. Valor predeterminado: `{}`.
Tags	Map	No	No	Se admite un máximo de 20 etiquetas compatibles.	Se admite un máximo de 20 etiquetas compatibles.
TemplateName	String	No	No	El nombre de la plantilla.	El nombre puede tener hasta 200 caracteres y no puede comenzar con ALIYUN, ACS ni ALIBABA. Puede contener letras, dígitos, guiones (-) y guiones bajos (_).
ParentExecutionId	String	No	No	El ID de la ejecución principal.	Ninguna
SafetyCheck	String	No	No	El modo de comprobación de seguridad.	Valores válidos: Skip: omite la comprobación de seguridad. Con este valor, indica que comprende los riesgos y puede ejecutar cualquier acción sin confirmación, independientemente del nivel de riesgo. Este valor surte efecto solo cuando Mode se establezca en Automatic. ConfirmEveryHighRiskAction (predeterminado): Es necesario que confirme cada acción de alto riesgo. Llame a la operación NotifyExecution para que confirme o cancele la acción.
Mode	String	No	No	El modo de ejecución.	Valores válidos: Debug Automatic (predeterminado)
TemplateVersion	String	No	No	El número de versión.	Si deja esta propiedad en blanco, se usa el número de versión más reciente.
ResourceGroupId	String	No	No	El ID del resource group.	Ninguna
LoopMode	String	No	No	El modo de bucle.	Ninguna
Description	String	No	No	La descripción que se agrega a la ejecución.	Ninguna
TemplateContent	String	No	No	El contenido de la plantilla.	El contenido debe estar en formato JSON o YAML. El contenido es el mismo que el campo Content de los parámetros de solicitud de la operación CreateTemplate. Especifique esta propiedad para que las tareas de TemplateContent se ejecuten directamente; no es necesario que cree una plantilla primero. Si cree la ejecución a partir de una plantilla existente, deje esta propiedad vacía.
TemplateURL	String	No	No	La URL del contenido de la plantilla de OOS almacenado en Alibaba Cloud Object Storage Service (OSS). Solo se admiten las URL compatibles con permisos de lectura pública.	Especifique esta propiedad para que se ejecute el contenido de la plantilla almacenado en TemplateURL; no es necesario que cree una plantilla primero. Si cree la ejecución a partir de una plantilla existente, deje esta propiedad vacía.

Sintaxis de ResourceOptions

"ResourceOptions": {
  "SuccessStatuses": List,
  "Timeout": Number,
  "CancelOnDelete": Boolean,
  "FailureStatuses": List
}

Propiedades de ResourceOptions

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricciones
SuccessStatuses	List	No	No	ROS usa esta propiedad para determinar si el recurso se crea correctamente.	Valores válidos: Started Queued Running Waiting Success (predeterminado) Failed Cancelled Si el estado de la ejecución está en `FailureStatuses`, se considera un estado con errores. Si el estado de la ejecución está en `SuccessStatuses`, se considera un estado correcto. Si no se cumple ninguna de las condiciones anteriores, se continúa esperando hasta que se agote el tiempo de espera (`Timeout`).
Timeout	Number	No	No	El tiempo de espera.	Unidad: segundos. Valor: 1800.
CancelOnDelete	Boolean	No	No	Especifica si se cancela la ejecución cuando se elimina el recurso y la ejecución no está completa.	Valores válidos: true: Cancela la ejecución. false (predeterminado): No cancela la ejecución.
FailureStatuses	List	No	No	ROS usa esta propiedad para determinar si el recurso se crea con errores. FailureStatuses tiene mayor prioridad que SuccessStatuses.	Valores válidos: Started Queued Running Waiting Success Failed Cancelled Valor predeterminado: `["Failed", "Cancelled"]`.

Valores de retorno

Fn::GetAtt

Status: El estado de la ejecución.
WindowsCurlCli: El prefijo del comando de la interfaz de línea de comandos (CLI) curl para Windows. Úselo para indicar que el procesamiento se completó o finalizó con errores. Para obtener más información, consulte NotifyExecution.
PowerShellCurlCli: El prefijo del comando de la CLI curl para PowerShell. Úselo para indicar que el procesamiento se completó o finalizó con errores.
Outputs: La salida de la ejecución.
ExecutionId: El identificador único de la ejecución.
CurlCli: El prefijo del comando de la CLI curl. Úselo para indicar que el procesamiento se completó o finalizó con errores.
StatusMessage: El mensaje de estado.
Counters: El recuento de ejecuciones.

Ejemplos

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  TemplateName:
    Type: String
    Description: Template name. Content is limited to letters, numbers, underlined, underline, the length of 200 characters, and can not begin to ALIYUN, ACS, ALIBABA.
    Label: Template Name
    ConstraintDescription: '[2, 128] English or Chinese characters'
    MinLength: 2
    MaxLength: 128
    Default: mytest
Resources:
  Execution:
    Type: ALIYUN::OOS::Execution
    Properties:
      Parameters: {}
      TemplateName:
        Ref: TemplateName
      ResourceOptions:
        SuccessStatuses:
          - Running
          - Success
          - Queued
          - Waiting
        CancelOnDelete: true
Outputs:
  Status:
    Description: Execution status.
    Value:
      Fn::GetAtt:
        - Execution
        - Status
  WindowsCurlCli:
    Description: 'Convenience attribute, provides curl CLI command prefix for Windows, which can be used to notify oos execution instead of OOS API NotifyExecution. You can notify approve to oos execution by adding --data-binary "{\"data\": {\"NotifyType\": \"Approve\"}}" You can also notify execution via ROS API SignalResource. API parameters Status and UniqueId are ignored. Use API parameter Data to pass data.'
    Value:
      Fn::GetAtt:
        - Execution
        - WindowsCurlCli
  PowerShellCurlCli:
    Description: 'Convenience attribute, provides curl CLI command prefix for PowerShell, which can be used to notify oos execution instead of OOS API NotifyExecution. You can notify approve to oos execution by adding -Body ''{"data": {"NotifyType": "Approve"}}'' You can also notify execution via ROS API SignalResource. API parameters Status and UniqueId are ignored. Use API parameter Data to pass data.'
    Value:
      Fn::GetAtt:
        - Execution
        - PowerShellCurlCli
  Outputs:
    Description: Execution output.
    Value:
      Fn::GetAtt:
        - Execution
        - Outputs
  ExecutionId:
    Description: Execution ID.
    Value:
      Fn::GetAtt:
        - Execution
        - ExecutionId
  CurlCli:
    Description: 'Convenience attribute, provides curl CLI command prefix, which can be used to notify oos execution instead of OOS API NotifyExecution. You can notify approve to oos execution by adding --data-binary ''{"data": {"NotifyType": "Approve"}}''  You can also notify execution via ROS API SignalResource. API parameters Status and UniqueId are ignored. Use API parameter Data to pass data.'
    Value:
      Fn::GetAtt:
        - Execution
        - CurlCli
  StatusMessage:
    Description: Execution status information.
    Value:
      Fn::GetAtt:
        - Execution
        - StatusMessage
  Counters:
    Description: 'Task statistics: FailedTasks, SuccessTasks, TotalTasks.'
    Value:
      Fn::GetAtt:
        - Execution
        - Counters

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "TemplateName": {
      "Type": "String",
      "Description": "Template name. Content is limited to letters, numbers, underlined, underline, the length of 200 characters, and can not begin to ALIYUN, ACS, ALIBABA.",
      "Label": "Template Name",
      "ConstraintDescription": "[2, 128] English or Chinese characters",
      "MinLength": 2,
      "MaxLength": 128,
      "Default": "mytest"
    }
  },
  "Resources": {
    "Execution": {
      "Type": "ALIYUN::OOS::Execution",
      "Properties": {
        "Parameters": {
        },
        "TemplateName": {
          "Ref": "TemplateName"
        },
        "ResourceOptions": {
          "SuccessStatuses": [
            "Running",
            "Success",
            "Queued",
            "Waiting"
          ],
          "CancelOnDelete": true
        }
      }
    }
  },
  "Outputs": {
    "Status": {
      "Description": "Execution status.",
      "Value": {
        "Fn::GetAtt": [
          "Execution",
          "Status"
        ]
      }
    },
    "WindowsCurlCli": {
      "Description": "Convenience attribute, provides curl CLI command prefix for Windows, which can be used to notify oos execution instead of OOS API NotifyExecution. You can notify approve to oos execution by adding --data-binary \"{\\\"data\\\": {\\\"NotifyType\\\": \\\"Approve\\\"}}\" You can also notify execution via ROS API SignalResource. API parameters Status and UniqueId are ignored. Use API parameter Data to pass data.",
      "Value": {
        "Fn::GetAtt": [
          "Execution",
          "WindowsCurlCli"
        ]
      }
    },
    "PowerShellCurlCli": {
      "Description": "Convenience attribute, provides curl CLI command prefix for PowerShell, which can be used to notify oos execution instead of OOS API NotifyExecution. You can notify approve to oos execution by adding -Body '{\"data\": {\"NotifyType\": \"Approve\"}}' You can also notify execution via ROS API SignalResource. API parameters Status and UniqueId are ignored. Use API parameter Data to pass data.",
      "Value": {
        "Fn::GetAtt": [
          "Execution",
          "PowerShellCurlCli"
        ]
      }
    },
    "Outputs": {
      "Description": "Execution output.",
      "Value": {
        "Fn::GetAtt": [
          "Execution",
          "Outputs"
        ]
      }
    },
    "ExecutionId": {
      "Description": "Execution ID.",
      "Value": {
        "Fn::GetAtt": [
          "Execution",
          "ExecutionId"
        ]
      }
    },
    "CurlCli": {
      "Description": "Convenience attribute, provides curl CLI command prefix, which can be used to notify oos execution instead of OOS API NotifyExecution. You can notify approve to oos execution by adding --data-binary '{\"data\": {\"NotifyType\": \"Approve\"}}'  You can also notify execution via ROS API SignalResource. API parameters Status and UniqueId are ignored. Use API parameter Data to pass data.",
      "Value": {
        "Fn::GetAtt": [
          "Execution",
          "CurlCli"
        ]
      }
    },
    "StatusMessage": {
      "Description": "Execution status information.",
      "Value": {
        "Fn::GetAtt": [
          "Execution",
          "StatusMessage"
        ]
      }
    },
    "Counters": {
      "Description": "Task statistics: FailedTasks, SuccessTasks, TotalTasks.",
      "Value": {
        "Fn::GetAtt": [
          "Execution",
          "Counters"
        ]
      }
    }
  }
}