Todos os produtos
Search

Este produto

    CloudOps Orchestration Service:StartExecution

    Central de documentação

    CloudOps Orchestration Service:StartExecution

    Última atualização: Sep 02, 2026

    Inicia uma execução de tarefa.

    Experimente agora

    Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

    Testar

    Autorização RAM

    A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

    • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

    • API: A API que você pode chamar para executar a ação.

    • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

    • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

      • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

      • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

    • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

    • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

    Ação

    Nível de acesso

    Tipo de recurso

    Chave de condição

    Ação dependente

    oos:StartExecution

    update

    *Execution

    acs:oos:{#regionId}:{#accountId}:execution/*
    • oos:tag
    • oos:IsOOSAssumeRole
    • oos:TLSVersion
    		 Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    RegionId

    string

    Não

    O ID da região.

    cn-hangzhou
    TemplateName

    string

    Não

    O nome do modelo. O nome pode conter letras, dígitos, hifens (-) e sublinhados (_), e pode ter até 200 caracteres de comprimento.

    vmeixme
    TemplateVersion

    string

    Não

    O número da versão. Se você não especificar este parâmetro, o número da versão mais recente será usado por padrão.

    v1
    Mode

    string

    Não

    O modo de execução. Valores válidos:

    • Automatic (padrão): execução automática

    • FailurePause: pausa em caso de falha

    • Debug: execução passo a passo

    Automatic
    LoopMode

    string

    Não

    O modo de loop. Valores válidos:

    • Automatic (padrão): não pausa

    • FirstBatchPause: pausa após o primeiro lote

    • EveryBatchPause: pausa após cada lote

    Automatic
    ParentExecutionId deprecated

    string

    Não

    O ID da execução pai.

    exec-xxx
    SafetyCheck

    string

    Não

    O modo de verificação de segurança. Valores válidos:

    • Skip (padrão): Esta opção indica que o cliente está ciente dos riscos e pode executar qualquer ação sem confirmação, independentemente do nível de risco. Esta opção é válida apenas quando Mode=Automatic.

    • ConfirmEveryHighRiskAction: Esta opção exige que o cliente confirme cada ação de alto risco. O cliente pode confirmar ou cancelar chamando a operação NotifyExecution.

    Skip
    Parameters

    string

    Não

    Uma string JSON que consiste em um conjunto de parâmetros. Valor padrão: {}.

    {"Status":"Running"}
    ClientToken

    string

    Não

    O token de acesso.

    123e56767-e89b-12d3-a456-426655440000
    Tags

    object

    Não

    As tags a serem adicionadas à execução da tarefa.

    { "k1": "v1", "k2": "v2" }
    Description

    string

    Não

    A descrição a ser adicionada à execução da tarefa.

    test execution
    TemplateContent

    string

    Não

    O conteúdo do modelo no formato JSON ou YAML. Este é o mesmo que o campo Content nos parâmetros de solicitação CreateTemplate. Se você especificar este parâmetro, poderá executar diretamente as tarefas definidas em TemplateContent sem criar um modelo primeiro. Você não precisa especificar este parâmetro se usar um modelo existente para criar uma execução de tarefa.

    { "Description": "Modelo de exemplo, descreve instâncias em algum status", "FormatVersion": "OOS-2019-06-01", "Parameters": {}, "Tasks": [ { "Name": "describeInstances", "Action": "ACS::ExecuteAPI", "Description": "desc-en", "Properties": { "Service": "ECS", "API": "DescribeInstances", "Parameters": { "Status": "Running" } } } ] }
    ResourceGroupId

    string

    Não

    O ID do grupo de recursos.

    rg-acfmxsn4m4******
    TemplateURL

    string

    Não

    A URL do conteúdo do modelo OOS armazenado no Alibaba Cloud Object Storage Service (OSS). Apenas URLs publicamente legíveis são suportadas. Se você especificar este parâmetro, poderá criar diretamente uma execução de tarefa com base no conteúdo do modelo armazenado na TemplateURL sem criar um modelo primeiro. Você não precisa especificar este parâmetro se usar um modelo existente para criar uma execução de tarefa.

    http://oos-template.cn-hangzhou.oss.aliyun-inc.com/oos-test-template.json

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    RequestId

    string

    O ID da solicitação.

    14A07460-EBE7-47CA-9757-12CC4761D47A
    Execution

    object

    Os dados da execução da tarefa.

    Outputs

    string

    A saída da execução da tarefa.

    { "InstanceId":"i-xxx" }
    Status

    string

    O status da execução.

    Success
    EndDate

    string

    A hora de término.

    2019-05-16T10:26:14Z
    ExecutedBy

    string

    O usuário que executou o modelo.

    root(13092080xx12344)
    IsParent

    boolean

    Indica se a execução da tarefa contém tarefas filhas.

    false
    Tags

    object

    As tags da execução da tarefa.

    {"k1":"v2","k2":"v2"}
    StartDate

    string

    A hora de início.

    2019-05-16T10:26:14Z
    SafetyCheck

    string

    O modo de verificação de segurança.

    Skip
    Mode

    string

    O modo de execução.

    Automatic
    TemplateName

    string

    O nome do modelo.

    MyTemplate
    CreateDate

    string

    A hora em que a execução da tarefa foi criada.

    2019-05-16T10:26:14Z
    TemplateVersion

    string

    O número da versão do modelo.

    v1
    ExecutionId

    string

    O identificador exclusivo da execução da tarefa.

    exec-xxxyyy
    Parameters

    string

    Os parâmetros de entrada da execução da tarefa.

    { "Status":"Running" }
    Description

    string

    A descrição da execução da tarefa.

    test execution
    Counters

    object

    O número de execuções.

    1
    UpdateDate

    string

    A hora da atualização.

    2019-05-16T10:26:14Z
    ResourceGroupId

    string

    O ID do grupo de recursos.

    rg-acfmxsn4m4******
    ParentExecutionId

    string

    O ID da execução pai.

    exec-xxxx
    RamRole

    string

    A função RAM usada para executar o modelo atual.

    OOSServiceRole
    TemplateId

    string

    O ID do modelo.

    t-1bd341007f
    StatusMessage

    string

    A mensagem de status.

    ""
    LoopMode

    string

    O modo de loop.

    Automatic
    CurrentTasks

    array<object>

    As tarefas que estão em execução no momento.

    object

    TaskExecutionId

    string

    O ID da execução da tarefa.

    exec-dsadasdawq
    TaskName

    string

    O nome da tarefa.

    testTask
    TaskAction

    string

    A ação da tarefa.

    ACS::TimerTrigger

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "Execution": {
    "Outputs": "{ \"InstanceId\":\"i-xxx\" }",
    "Status": "Success",
    "EndDate": "2019-05-16T10:26:14Z",
    "ExecutedBy": "root(13092080xx12344)",
    "IsParent": false,
    "Tags": {
      "k1": "v2",
      "k2": "v2"
    },
    "StartDate": "2019-05-16T10:26:14Z",
    "SafetyCheck": "Skip",
    "Mode": "Automatic",
    "TemplateName": "MyTemplate",
    "CreateDate": "2019-05-16T10:26:14Z",
    "TemplateVersion": "v1",
    "ExecutionId": "exec-xxxyyy",
    "Parameters": "{ \"Status\":\"Running\" }",
    "Description": "Execução de teste",
    "Counters": 1,
    "UpdateDate": "2019-05-16T10:26:14Z",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "ParentExecutionId": "exec-xxxx",
    "RamRole": "OOSServiceRole",
    "TemplateId": "t-1bd341007f",
    "StatusMessage": "\"\"",
    "LoopMode": "Automatic",
    "CurrentTasks": [
      {
        "TaskExecutionId": "exec-dsadasdawq",
        "TaskName": "testTask",
        "TaskAction": "ACS::TimerTrigger"
      }
    ]
  }
}

    Códigos de erro

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.