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

Consulta os detalhes das tarefas agendadas. Uma tarefa agendada é uma tarefa predefinida que executa uma regra de dimensionamento especificada em um horário especificado para implementar o scale-out e scale-in automáticos de recursos de computação. Após a criação de uma tarefa agendada, você pode chamar a operação de API DescribeScheduledTasks para consultar os detalhes da tarefa agendada, como o horário de acionamento, o número total de tarefas agendadas e o ID do grupo de dimensionamento que executa a tarefa agendada.

Descrição da operação

Você pode consultar tarefas agendadas pelo ID da tarefa agendada, pelo nome da tarefa agendada ou pela regra de dimensionamento executada pela 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 dimensionamento ao qual a tarefa agendada pertence.	cn-qingdao
PageNumber	integer	Não	O número da página da lista de tarefas agendadas. As páginas começam em 1. Valor padrão: 1.	1
PageSize	integer	Não	Configurações para o número de entradas por página durante a paginação em uma consulta paginada. Valor máximo: 50. Valor padrão: 10.	50
ScalingGroupId	string	Não	O ID do grupo de dimensionamento que executa a tarefa agendada.	asg-bp1bo5tca4m56nap****
ScheduledActions	array	Não	As regras de dimensionamento usadas quando as tarefas agendadas são acionadas. Este parâmetro é válido apenas quando uma regra de dimensionamento é especificada para as tarefas agendadas.
	string	Não	A regra de dimensionamento usada quando a tarefa agendada é acionada. Este parâmetro é válido apenas quando uma regra de dimensionamento é especificada para a tarefa agendada. O valor é o identificador exclusivo da regra de dimensionamento (ScalingRuleAri).	ari:acs:ess:cn-hangzhou:1406926474**:scalingrule/asr-bp1id5rhu8edp7kd**
ScheduledTaskIds	array	Não	Os IDs das tarefas agendadas a serem consultadas.
	string	Não	Os IDs das tarefas agendadas a serem consultadas.	edRtShc57WGXdt8TlPbr****
ScheduledTaskNames	array	Não	Os nomes das tarefas agendadas a serem consultadas.
	string	Não	Os nomes das tarefas agendadas a serem consultadas.	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 uma vez 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 na expressão cron especificada.	Weekly
RecurrenceValue	string	Não	O valor de recorrência da tarefa agendada. Este parâmetro tem suporte 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. Valores válidos: true: A tarefa está ativada. false: A tarefa está desativada.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageNumber	integer	O número da página atual.	1
PageSize	integer	O número de entradas retornadas por página.	50
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
ScheduledTasks	array<object>	As tarefas agendadas.
	array<object>	As tarefas agendadas.
Description	string	A descrição da tarefa agendada.	Test scheduled task.
DesiredCapacity	integer	O número esperado de instâncias no grupo de dimensionamento. Este parâmetro é válido quando o método de dimensionamento da tarefa agendada está definido como a configuração do número de instâncias no grupo de dimensionamento.	10
LaunchExpirationTime	integer	O período de nova tentativa após a falha no acionamento da tarefa agendada. Unidade: segundos. Valores válidos: 0 a 21600.	600
LaunchTime	string	O horário em que a tarefa agendada é acionada. O horário segue o padrão ISO 8601 no formato AAAA-MM-DDTHH:mmZ. O horário é exibido em UTC.	2014-08-18T10:52Z
MaxValue	integer	O número máximo de instâncias no grupo de dimensionamento. Este parâmetro é válido quando o método de dimensionamento da tarefa agendada está definido como a configuração do número de instâncias no grupo de dimensionamento.	10
MinValue	integer	O número mínimo de instâncias no grupo de dimensionamento. Este parâmetro é válido quando o método de dimensionamento da tarefa agendada está definido como a configuração do número de instâncias no grupo de dimensionamento.	0
RecurrenceEndTime	string	O horário de término da recorrência da tarefa agendada. O horário segue o padrão ISO 8601 no formato AAAA-MM-DDTHH:mmZ. O horário é exibido em UTC.	2014-08-20T16:55Z
RecurrenceType	string	O tipo de recorrência da tarefa agendada.	Daily
RecurrenceValue	string	O valor de recorrência da tarefa agendada.	1
ScalingGroupId	string	O ID do grupo de dimensionamento que executa a tarefa agendada.	asg-bp1bo5tca4m56nap****
ScheduledAction	string	A regra de dimensionamento executada quando a tarefa agendada é acionada. Este parâmetro é retornado apenas quando uma regra de dimensionamento é especificada para a tarefa agendada.	ari:acs:ess:cn-hangzhou:1406926474**:scalingrule/asr-bp1id5rhu8edp7kd**
ScheduledTaskId	string	O ID da tarefa agendada.	edRtShc57WGXdt8TlPbr****
ScheduledTaskName	string	O nome da tarefa agendada.	scheduled****
TaskEnabled	boolean	Indica se a tarefa agendada está ativada. Valores válidos: true: A tarefa está ativada. false: A tarefa está desativada. Valor padrão: true.	true
WarmPoolCapacityOptions	object	As configurações de capacidade do warm pool do grupo de dimensionamento.
DesiredGroupPreparedCapacity	integer	O número esperado de instâncias preparadas.	5
MinCapacity	integer	O número mínimo de instâncias no warm pool.	0
TotalCount	integer	O número total de tarefas agendadas.	1

Exemplos

Resposta de sucesso

JSON formato

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

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.