ListExecutions - CloudOps Orchestration Service: Central de Documentação do Alibaba Cloud

Consulta execuções de tarefas com suporte a múltiplos métodos de filtragem.

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:ListExecutions

list

*Execution

acs:oos:{#regionId}:{#accountId}:execution/*

*Execution

acs:oos:{#regionId}:{#accountId}:execution/{#executionId}

oos:tag
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. Esta é uma correspondência aproximada. Todos os modelos cujos nomes contêm o valor especificado são retornados.	MyTemplate
Status	string	Não	O status da execução. Valores válidos: Running, Started, Success, Failed, Waiting, Cancelled, Pending, Skipped.	Running
ExecutionId	string	Não	O ID da execução.	exec-xxx
StartDateBefore	string	Não	Especifica que a hora de início das execuções a serem consultadas é anterior ou igual à hora especificada.	2019-05-16T10:26:14Z
StartDateAfter	string	Não	Especifica que a hora de início das execuções a serem consultadas é posterior ou igual à hora especificada.	2019-05-16T10:26:14Z
EndDateBefore	string	Não	Especifica que a hora de término das execuções a serem consultadas é anterior ou igual à hora especificada.	2019-05-16T10:26:14Z
EndDateAfter	string	Não	Especifica que a hora de término das execuções a serem consultadas é posterior ou igual à hora especificada.	2019-05-16T10:26:14Z
Mode	string	Não	O modo de execução. Valores válidos: Automatic Debug	Automatic
ExecutedBy	string	Não	O executor.	vme
ParentExecutionId	string	Não	O ID da execução pai.	exec-xxx
RamRole	string	Não	A função RAM.	OOSServiceRole
IncludeChildExecution	boolean	Não	Especifica se as execuções filhas devem ser incluídas. Valor padrão: False.	true
Category	string	Não	O tipo de modelo da execução. Valores válidos: Other, TimerTrigger, EventTrigger, AlarmTrigger.	Other
Tags	object	Não	As tags da execução.	{ "k1": "v1", "k2": "v2" }
MaxResults	integer	Não	O número de entradas por página. Valores válidos: 10 a 100. Valor padrão: 50.	50
NextToken	string	Não	O token de paginação.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ
SortField	string	Não	O campo usado para classificar os resultados da consulta. Valores válidos: StartDate (padrão): a hora de criação. EndDate: a hora de término. Status: o status.	StartDate
SortOrder	string	Não	A ordem de classificação. Valores válidos: Ascending: ordem crescente. Descending (padrão): ordem decrescente.	Ascending
ResourceId	string	Não	O ID do recurso ECS.	i-xxx
ResourceTemplateName	string	Não	O nome do modelo do recurso.	ACS-ECS-TEST
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmxsn4m4******
Description	string	Não	A descrição da execução.	MyDescription
Depth	string	Não	A profundidade da execução. Valores válidos: RootDepth, FirstChildDepth. RootDepth retorna apenas as execuções raiz. FirstChildDepth retorna apenas as execuções filhas de primeiro nível. Você pode especificar apenas um entre este parâmetro e o parâmetro IncludeChildExecution. Recomendamos que você use Depth.	RootDepth
Categories	string	Não	A lista de tipos de modelo para a execução. Valores válidos: Other, TimerTrigger, EventTrigger, AlarmTrigger. Você pode especificar apenas um entre este parâmetro e o parâmetro Category. Recomendamos que você use Categories.	["TimerTrigger"、"EventTrigger"]
RdFolderIds	array	Não
	string	Não		rd-xxx
AccountId	string	Não		123456789

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextToken	string	O token de paginação.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ
RequestId	string	O ID da solicitação.	14A074-47CA-9757-12CC4761D47A
MaxResults	integer	O número de entradas por página.	50
Executions	array<object>	Os dados da execução.
	array<object>
Status	string	O status da execução. Valores válidos: Started, Queued, Running, Waiting, Success, Failed, Cancelled.	Success
WaitingStatus	string	O status de espera.	""
Targets	string	Os recursos de destino.	"{"ResourceType": "ALIYUN::ECS::Instance", "Filters": [{"ResourceIds": ["i-bp14z07dg3464980x72o"], "RegionId": "cn-hangzhou", "Type": "ResourceIds"}]}"
StatusReason	string	O motivo do status.	""
Tags	object	As tags da execução.	{}
LastSuccessfulTriggerTime	string	A hora em que o modelo foi acionado com sucesso pela última vez.	2019-05-27T09:29:18Z
Mode	string	O modo de execução.	Automatic
SafetyCheck	string	O modo de verificação de segurança. Valores válidos: Skip, ConfirmEveryHighRiskAction.	Skip
TemplateName	string	O nome do modelo.	MyTemplate
TemplateVersion	string	O número da versão do modelo.	v1
CreateDate	string	A hora em que a execução foi criada.	2019-05-16T10:26:14Z
UpdateDate	string	A hora em que a execução foi atualizada.	2019-05-16T10:26:14Z
Description	string	A descrição da execução.	MyDescription
LastTriggerTime	string	A hora em que o modelo foi acionado pela última vez.	2019-05-27T09:29:18Z
ParentExecutionId	string	O ID da execução pai.	exec-xxx
LastTriggerStatus	string	O status da execução após o último acionamento do modelo.	Success
StatusMessage	string	O status da execução da tarefa.	“”
Outputs	string	A saída da execução.	{ "InstanceId":"i-xxx" }
ExecutedBy	string	O usuário que executou o modelo.	1309252800
EndDate	string	A hora em que a execução terminou.	2019-05-16T10:26:14Z
IsParent	boolean	Indica se a execução contém tarefas filhas.	false
StartDate	string	A hora em que a execução começou.	2019-05-16T10:26:14Z
ExecutionId	string	O identificador exclusivo da execução.	exec-44d32b45d2a449e
Parameters	object	Os parâmetros de entrada da execução.	{ "Status":"Running" }
Counters	object	A contagem de tarefas agrupada por status de execução.	{"Failed": 0,"Success": 1,"Total": 2}
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmxsn4m4******
Category	string	O tipo de modelo da execução. Valores válidos: Other, TimerTrigger, EventTrigger, AlarmTrigger.	Other
TemplateId	string	O ID do modelo.	123
RamRole	string	A função RAM usada para executar o modelo atual.	OOSServiceRole
ResourceStatus	string	O status do recurso.	{ "Success": 1 }
CurrentTasks	array<object>	As tarefas que estão em execução no momento.
	object
TaskExecutionId	string	O ID da execução da tarefa.	task-exec-44d32b45d2a49899#1
TaskName	string	O nome da tarefa.	installSLSILogtail
TaskAction	string	O modelo de execução da tarefa.	acs::Template
LastTriggerStatusMessage	string	O status mais recente da execução da tarefa. Para execuções acionadas por temporizador, evento e alarme, este campo indica o status da execução do acionamento mais recente. Para execuções não acionadas, este campo é igual ao campo StatusMessage.	""
LastTriggerOutputs	string	A saída mais recente da execução. Para execuções acionadas por temporizador, evento e alarme, este campo indica a saída do acionamento mais recente. Para execuções não acionadas, este campo é igual ao campo Outputs.	{ "InstanceId": "i-xxx" }
NextScheduleTime	string	A próxima hora de acionamento para execuções acionadas por temporizador.	2019-05-16T10:26:14Z
AccountId	string		123456789
TotalCount	integer	O número total de execuções.	30

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ",
  "RequestId": "14A074-47CA-9757-12CC4761D47A",
  "MaxResults": 50,
  "Executions": [
    {
      "Status": "Success",
      "WaitingStatus": "\"\"",
      "Targets": "\"{\"ResourceType\": \"ALIYUN::ECS::Instance\", \"Filters\": [{\"ResourceIds\": [\"i-bp14z07dg3464980x72o\"], \"RegionId\": \"cn-hangzhou\", \"Type\": \"ResourceIds\"}]}\"",
      "StatusReason": "\"\"",
      "Tags": {},
      "LastSuccessfulTriggerTime": "2019-05-27T09:29:18Z",
      "Mode": "Automatic",
      "SafetyCheck": "Skip",
      "TemplateName": "MyTemplate",
      "TemplateVersion": "v1",
      "CreateDate": "2019-05-16T10:26:14Z",
      "UpdateDate": "2019-05-16T10:26:14Z",
      "Description": "MyDescription",
      "LastTriggerTime": "2019-05-27T09:29:18Z",
      "ParentExecutionId": "exec-xxx",
      "LastTriggerStatus": "Success",
      "StatusMessage": "“”",
      "Outputs": "{ \"InstanceId\":\"i-xxx\" }",
      "ExecutedBy": "1309252800",
      "EndDate": "2019-05-16T10:26:14Z",
      "IsParent": false,
      "StartDate": "2019-05-16T10:26:14Z",
      "ExecutionId": "exec-44d32b45d2a449e",
      "Parameters": {
        "Status": "Running"
      },
      "Counters": {
        "Failed": 0,
        "Success": 1,
        "Total": 2
      },
      "ResourceGroupId": "rg-acfmxsn4m4******",
      "Category": "Other",
      "TemplateId": "123",
      "RamRole": "OOSServiceRole",
      "ResourceStatus": "{ \t\t\t\"Success\": 1 \t\t}",
      "CurrentTasks": [
        {
          "TaskExecutionId": "task-exec-44d32b45d2a49899#1",
          "TaskName": "installSLSILogtail",
          "TaskAction": "acs::Template"
        }
      ],
      "LastTriggerStatusMessage": "\"\"",
      "LastTriggerOutputs": "{\n      \"InstanceId\": \"i-xxx\"\n}",
      "NextScheduleTime": "2019-05-16T10:26:14Z",
      "AccountId": "123456789"
    }
  ],
  "TotalCount": 30
}

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.