Use ALIYUN::OOS::Execution in a call to start an execution - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

O tipo ALIYUN::OOS::Execution inicia uma execução.

Sintaxe

{
  "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
  }
}

Propriedades

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
ResourceOptions	Map	Não	Não	Opções de recurso que o Resource Orchestration Service (ROS) utiliza.	Para mais informações, consulte Propriedades de ResourceOptions.
Parameters	Map	Não	Não	Strings JSON compostas por parâmetros.	Exemplo: `{"Status": "Running"}`. Valor padrão: {}.
Tags	Map	Não	Não	As tags. Cada tag é um par chave-valor. Exemplo: {"k1":"v1", "k2":"v2"}.	Limite de 20 tags.
TemplateName	String	Não	Não	Nome do modelo.	O nome pode ter até 200 caracteres. Não deve começar com ALIYUN, ACS ou ALIBABA. Pode conter letras, dígitos, hifens (-) e sublinhados (_).
ParentExecutionId	String	Não	Não	ID da execução pai.	Nenhuma.
SafetyCheck	String	Não	Não	Modo de verificação de segurança.	Valores válidos: Skip: ignora a confirmação manual para todas as ações, independentemente dos níveis de risco. Este valor é válido quando Mode está definido como Automatic. ConfirmEveryHighRiskAction (padrão): exige confirmação manual para cada ação de alto risco. Use a operação NotifyExecution para confirmar ou cancele uma ação.
Mode	String	Não	Não	Modo de execução.	Valores válidos: Debug Automatic (padrão)
TemplateVersion	String	Não	Não	Número da versão.	Se esta propriedade estiver vazia, o sistema usa a versão mais recente.
ResourceGroupId	String	Não	Não	ID do grupo de recursos.	Nenhuma.
LoopMode	String	Não	Não	Modo de loop.	Nenhuma.
Description	String	Não	Não	Descrição da execução.	Nenhuma.
TemplateContent	String	Não	Não	Conteúdo do modelo.	O conteúdo do modelo deve estar no formato JSON ou YAML. Esta propriedade tem o mesmo efeito que o parâmetro Content na operação CreateTemplate. Especifique esta propriedade para executar diretamente as tarefas definidas no conteúdo do modelo, sem necessidade de criar separadamente um modelo e tarefas. Caso use TemplateName para especificar um modelo existente, deixe TemplateContent vazio.
TemplateURL	String	Não	Não	URL do recurso do Object Storage Service (OSS) onde o conteúdo do modelo do CloudOps Orchestration Service (OOS) está armazenado. Somente URLs com leitura pública são suportadas.	Especifique esta propriedade para crie diretamente as tarefas definidas no conteúdo do modelo, eliminando a necessidade de criar separadamente um modelo e tarefas. Se usar TemplateName para indicar um modelo existente, deixe TemplateURL vazio.

Sintaxe de ResourceOptions

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

Propriedades de ResourceOptions

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
SuccessStatuses	List	Não	Não	Estados que indicam se os recursos foram criados.	Valores válidos: Started Queued Running Waiting Success (padrão) Failed Cancelled Se o estado da execução constar na propriedade FailureStatuses, a criação dos recursos falhou. Se constar em SuccessStatuses, os recursos foram criados com êxito. Caso nenhuma dessas condições seja atendida, o sistema aguarda até que a solicitação atinja o tempo limite.
Timeout	Number	Não	Não	Tempo limite.	Unidade: segundos. Valor padrão: 1800.
CancelOnDelete	Boolean	Não	Não	Defina se a execução incompleta deve ser cancelada durante a exclusão do recurso.	Valores válidos: true false (padrão)
FailureStatuses	List	Não	Não	Estados que indicam falha na criação dos recursos. A propriedade FailureStatuses tem precedência sobre SuccessStatuses.	Valores válidos: Started Queued Running Waiting Success Failed Cancelled Valor padrão: `["Failed", "Cancelled"]`.

Valores de retorno

Fn::GetAtt

Status: estado da execução.
WindowsCurlCli: prefixo de comando cURL CLI fornecido para Windows. O WindowsCurlCli envia um sinal indicando se a execução foi concluída ou falhou. Para mais informações, consulte NotifyExecution.
PowerShellCurlCli: prefixo de comando cURL CLI fornecido para PowerShell. O PowerShellCurlCli envia um sinal indicando se a execução foi concluída ou falhou.
Outputs: saídas da execução.
ExecutionId: ID exclusivo da execução.
CurlCli: comando cURL.
StatusMessage: informações de status.
Counters: quantidade de execuções.

Exemplos

YAML format

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 format

{
  "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"
        ]
      }
    }
  }
}