ALIYUN::OOS::Execution - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

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ória	Editável	Descrição	Restrições
ResourceOptions	Map	Não	Não	Para mais informações, consulte Propriedades de ResourceOptions.	Para mais informações, consulte Propriedades de ResourceOptions.
Parameters	Map	Não	Não	Exemplo: `{"Status": "Running"}`. Valor padrão: {}.	Exemplo: `{"Status": "Running"}`. Valor padrão: `{}`.
Tags	Map	Não	Não	Suporta no máximo 20 tags.	Limite de 20 tags.
TemplateName	String	Não	Não	Nome do modelo.	O nome pode ter até 200 caracteres e não pode 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 verificação de segurança. Assume-se que você compreende os riscos e permite executar qualquer ação sem confirmação, independentemente do nível de risco. Este valor tem efeito apenas quando Mode está definido como Automatic. ConfirmEveryHighRiskAction (padrão): exige confirmação para cada ação de alto risco. Chame a operação NotifyExecution para confirmar ou cancele a 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 em branco, 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 deve estar no formato JSON ou YAML e corresponde ao campo Content nos parâmetros de solicitação da operação CreateTemplate. Se você especificar esta propriedade, as tarefas em TemplateContent executam diretamente, sem necessidade de criar um modelo antes. Caso crie a execução a partir de um modelo existente, deixe esta propriedade vazia.
TemplateURL	String	Não	Não	URL do conteúdo do modelo OOS armazenado no Alibaba Cloud Object Storage Service (OSS). Apenas URLs com permissão de leitura pública são suportadas.	Ao especificar esta propriedade, a execução usa o conteúdo do modelo armazenado em TemplateURL, eliminando a necessidade de criar um modelo antes. Se a execução for criada a partir de um modelo existente, mantenha esta propriedade vazia.

Sintaxe de ResourceOptions

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

Propriedades de ResourceOptions

Propriedade	Tipo	Obrigatória	Editável	Descrição	Restrições
SuccessStatuses	List	Não	Não	O ROS usa esta propriedade para determinar se o recurso foi criado com sucesso.	Valores válidos: Started Queued Running Waiting Success (padrão) Failed Cancelled Se o status da execução estiver em `FailureStatuses`, considera-se uma falha. Se estiver em `SuccessStatuses`, considera-se um sucesso. Caso nenhuma das condições acima seja atendida, o sistema continua aguardando até o tempo limite (`Timeout`).
Timeout	Number	Não	Não	Tempo limite.	Unidade: segundos. Valor: 1800.
CancelOnDelete	Boolean	Não	Não	Define se a execução deve ser cancelada caso não tenha sido concluída no momento da exclusão do recurso.	Valores válidos: true: cancela a execução. false (padrão): não cancela a execução.
FailureStatuses	List	Não	Não	O ROS usa esta propriedade para identificar falhas na criação do recurso. FailureStatuses tem prioridade sobre SuccessStatuses.	Valores válidos: Started Queued Running Waiting Success Failed Cancelled Valor padrão: `["Failed", "Cancelled"]`.

Valores de retorno

Fn::GetAtt

Status: status da execução.
WindowsCurlCli: prefixo do comando curl CLI para Windows. Use-o para sinalizar que o processamento foi concluído ou falhou. Para mais informações, consulte NotifyExecution.
PowerShellCurlCli: prefixo do comando curl CLI para PowerShell. Use-o para indicar conclusão ou falha no processamento.
Outputs: saída da execução.
ExecutionId: identificador único da execução.
CurlCli: prefixo do comando curl CLI. Use-o para sinalizar término ou falha do processamento.
StatusMessage: mensagem de status.
Counters: contagem de execuções.

Exemplos

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