DescribeScheduledTasks - Auto Scaling: Central de Documentação do Alibaba Cloud

Consulta informações sobre tarefas agendadas.

Descrição da operação

Você pode consultar tarefas agendadas pelo ID da tarefa agendada, nome da tarefa agendada ou regra de escalonamento associada à tarefa agendada.

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

ess:DescribeScheduledTasks

get

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do grupo de escalonamento ao qual a tarefa agendada pertence.	cn-qingdao
PageNumber	integer	Não	O número da página da lista de tarefas agendadas. Valor mínimo: 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página para uma consulta paginada. Valor máximo: 50. Valor padrão: 10.	50
ScalingGroupId	string	Não	O ID do grupo de escalonamento que executa a tarefa agendada.	asg-bp1bo5tca4m56nap****
ScheduledAction	array	Não	A regra de escalonamento usada quando a tarefa agendada é acionada. Este parâmetro é retornado apenas quando a tarefa agendada especifica uma regra de escalonamento.	ari:acs:ess:cn-hangzhou:1406926474**:scalingrule/asr-bp1id5rhu8edp7kd**
	string	Não	A regra de escalonamento usada quando a tarefa agendada é acionada. Este parâmetro é retornado apenas quando a tarefa agendada especifica uma regra de escalonamento. Valores válidos de N: 0 a 20. O valor é o identificador exclusivo da regra de escalonamento (ScalingRuleAri).	ari:acs:ess:cn-hangzhou:1406926474**:scalingrule/asr-bp1id5rhu8edp7kd**
ScheduledTaskId	array	Não	O ID da tarefa agendada a ser consultada.	edRtShc57WGXdt8TlPbr****
	string	Não	O ID da tarefa agendada a ser consultada. Valores válidos de N: 1 a 20.	edRtShc57WGXdt8TlPbr****
ScheduledTaskName	array	Não	O nome da tarefa agendada a ser consultada.	scheduled****
	string	Não	O nome da tarefa agendada a ser consultada. Valores válidos de N: 1 a 20.	scheduled****
TaskName	string	Não	O nome da tarefa. Há suporte para correspondência aproximada por palavra-chave.	scheduled****
RecurrenceType	string	Não	O tipo de recorrência da tarefa agendada. Valores válidos: Daily: A tarefa agendada é executada a cada número especificado de dias. Weekly: A tarefa agendada é executada em dias especificados de cada semana. Monthly: A tarefa agendada é executada em dias especificados de cada mês. Cron: A tarefa agendada é executada com base em uma expressão cron especificada.	Weekly
RecurrenceValue	string	Não	O valor de recorrência da tarefa agendada. Este parâmetro é suportado apenas quando RecurrenceType está definido como Weekly. Você pode especificar vários valores separados por vírgulas (,). Por exemplo, os valores para domingo, segunda-feira, terça-feira, quarta-feira, quinta-feira, sexta-feira e sábado são 0, 1, 2, 3, 4, 5 e 6.	1,2,3
TaskEnabled	boolean	Não	Especifica se a tarefa agendada está ativada. true: A tarefa está ativada. false: A tarefa está desativada.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumber	integer	O número da página atual.	1
PageSize	integer	O número de entradas por página.	50
TotalCount	integer	O número total de tarefas agendadas.	1
ScheduledTasks	object
ScheduledTask	array<object>	A coleção de informações de tarefas agendadas.
	object	A coleção de informações de tarefas agendadas.
TaskEnabled	boolean	Indicates whether the scheduled task is enabled. true: The task is enabled. false: The task is disabled. Default value: true.	true
RecurrenceValue	string	The recurrence value of the scheduled task.	1
RecurrenceType	string	The recurrence type of the scheduled task.	Daily
MaxValue	integer	The maximum number of instances in the scaling group. This parameter is returned when the scaling method of the scheduled task is set to configure the number of instances in the scaling group.	10
ScheduledTaskName	string	The name of the scheduled task.	scheduled****
RecurrenceEndTime	string	The end time of the recurrence of the scheduled task.	2014-08-20T16:55Z
DesiredCapacity	integer	The expected number of instances in the scaling group. This parameter is returned when the scaling method of the scheduled task is set to configure the number of instances in the scaling group.	10
ScheduledTaskId	string	The ID of the scheduled task.	edRtShc57WGXdt8TlPbr****
MinValue	integer	The minimum number of instances in the scaling group. This parameter is returned when the scaling method of the scheduled task is set to configure the number of instances in the scaling group.	0
ScalingGroupId	string	The ID of the scaling group that executes the scheduled task.	asg-bp1bo5tca4m56nap****
LaunchExpirationTime	integer	The time period during which a retry is performed after the scheduled task fails to be triggered. Unit: seconds. Valid values: 0 to 21600.	600
Description	string	The description of the scheduled task.	Test scheduled task.
ScheduledAction	string	The scaling rule used when the scheduled task is executed. This parameter is returned only when the scheduled task specifies a scaling rule.	ari:acs:ess:cn-hangzhou:1406926474**:scalingrule/asr-bp1id5rhu8edp7kd**
LaunchTime	string	The point in time at which the scheduled task is triggered.	2014-08-18T10:52Z

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 1,
  "ScheduledTasks": {
    "ScheduledTask": [
      {
        "TaskEnabled": true,
        "RecurrenceValue": "1",
        "RecurrenceType": "Daily",
        "MaxValue": 10,
        "ScheduledTaskName": "scheduled****",
        "RecurrenceEndTime": "2014-08-20T16:55Z",
        "DesiredCapacity": 10,
        "ScheduledTaskId": "edRtShc57WGXdt8TlPbr****",
        "MinValue": 0,
        "ScalingGroupId": "asg-bp1bo5tca4m56nap****",
        "LaunchExpirationTime": 600,
        "Description": "Test scheduled task.",
        "ScheduledAction": "ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****",
        "LaunchTime": "2014-08-18T10:52Z"
      }
    ]
  }
}

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.