DescribeHistoryTasks - Tair (Redis® OSS-Compatible): Central de Documentação do Alibaba Cloud

Consulta uma lista de tarefas no centro de tarefas.

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

kvstore:DescribeHistoryTasks

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-beijing
PageSize	integer	Não	O número de entradas por página. Valores válidos: 10 a 100. Valor padrão: 10.	10
PageNumber	integer	Não	O número da página. As páginas começam na página 1. Valor padrão: 1.	1
InstanceType	string	Não	Defina o valor como Instance.	Instance
Status	string	Não	O status da tarefa. Valores válidos: Scheduled Running Succeed Failed Cancelling Canceled Waiting Nota Este parâmetro está vazio por padrão, o que indica que tarefas em todos os estados são consultadas. Separe vários estados com vírgulas (,).	Scheduled
InstanceId	string	Não	O ID da instância. Este parâmetro está vazio por padrão, o que indica que você pode especificar um número ilimitado de IDs de instância. Separe vários IDs de instância com vírgulas (,). Você pode especificar até 30 IDs de instância.	r-uf62br2491p5l****
TaskId	string	Não	O ID da tarefa. Este parâmetro está vazio por padrão, o que indica que você pode especificar um número ilimitado de IDs de tarefa. Separe vários IDs de tarefa com vírgulas (,). Você pode especificar até 30 IDs de tarefa.	t-83br18hloy3faf****
TaskType	string	Não	O tipo de tarefa. Este parâmetro está vazio por padrão, o que indica que você pode especificar um número ilimitado de tipos de tarefa. ModifyInsSpec DeleteInsNode AddInsNode HaSwitch RestartIns CreateIns ModifyInsConfig Nota Separe vários tipos de tarefa com vírgulas (,).	ModifyInsSpec
FromStartTime	string	Sim	O início do intervalo de tempo a ser consultado. Especifique a hora no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC. A hora de início pode ser até 30 dias anterior à hora atual.	2022-01-02T11:31:03Z
ToStartTime	string	Sim	O fim do intervalo de tempo a ser consultado. Especifique a hora no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC. Apenas tarefas que tenham uma hora de início anterior ou igual à hora especificada por este parâmetro são consultadas.	2022-02-02T11:31:03Z
FromExecTime	integer	Não	A duração mínima de execução de uma tarefa. Este parâmetro é usado para filtrar tarefas cuja duração de execução seja maior que a duração mínima de execução. Unidade: segundos. O valor padrão é 0, o que indica que nenhum limite é imposto.	0
ToExecTime	integer	Não	A duração máxima de execução de uma tarefa. Este parâmetro é usado para filtrar tarefas cuja duração de execução seja menor ou igual à duração máxima de execução. Unidade: segundos. O valor padrão é 0, o que indica que nenhum limite é imposto.	0

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageNumber	integer	O número da página retornada.	1
RequestId	string	O ID da solicitação.	5D622714-AEDD-4609-9167-F5DDD3D1****
PageSize	integer	O número máximo de entradas retornadas por página.	10
TotalCount	integer	O número total de tarefas que atendem a essas restrições sem levar a paginação em consideração.	5
Items	array<object>	Os objetos de tarefa consultados.
	object
Status	string	O status da tarefa. Scheduled Running Succeed Failed Cancelling Canceled Waiting	Running
TaskId	string	O ID da tarefa.	t-83br18hloy3faf****
CurrentStepName	string	O nome da etapa atual. Se este parâmetro estiver vazio, a tarefa não foi iniciada.	exec_task
StartTime	string	A hora de início da tarefa. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2022-02-03T11:31:03Z
EndTime	string	A hora de término da tarefa. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2022-02-03T12:06:17Z
TaskType	string	O tipo de tarefa. ModifyInsSpec DeleteInsNode AddInsNode HaSwitch RestartIns CreateIns ModifyInsConfig	ModifyInsSpec
RemainTime	integer	A quantidade estimada de tempo restante para concluir a tarefa. Unidade: segundos. Um valor de 0 indica que a tarefa foi concluída.	1000
Progress	number	O progresso da tarefa. Valores válidos: 0 a 100.	79.0
RegionId	string	O ID da região.	cn-shanghai
InstanceType	string	O tipo de instância. O valor retornado é Instance.	Instance
InstanceId	string	O ID da instância.	r-bp1zxszhcgatnx****
InstanceName	string	O nome da instância.	dba-tair-test-qcloud
DbType	string	O tipo de banco de dados. O valor retornado é redis.	redis
Product	string	O produto. O valor retornado é kvstore.	kvstore
TaskDetail	string	Os detalhes da tarefa. Os detalhes variam de acordo com o tipo de tarefa.	{\"callerUid\":\"test\"}
ReasonCode	string	O motivo pelo qual a tarefa atual foi iniciada.	小版本升级
ActionInfo	string	Um conjunto de ações permitidas que podem ser executadas na tarefa. O sistema corresponde o nome da etapa atual e o status da tarefa às ações disponíveis especificadas por ActionInfo. Se nenhuma ação correspondente for encontrada, o status atual da tarefa não suportará nenhuma ação. Exemplo: `{"steps": [ { "step_name": "exec_task", // O nome da etapa, que corresponde a CurrentStepName. "action_info": { // As ações suportadas para esta etapa. "Waiting": [ // O status, que corresponde a Status. "modifySwitchTime" // A ação. Várias ações são suportadas. ] } }, { "step_name": "init_task", // O nome da etapa. "action_info": { // As ações suportadas para esta etapa. "Running": [ // O status. "cancel", // A ação. "pause" ] } } ] }` O sistema pode suportar as seguintes ações: retry cancel modifySwitchTime: altera a hora de troca ou restauração.	{"steps":[{"action_info":{"Waiting":["modifySwitchTime"]},"step_name":"exec_task"}]}
Uid	string	O ID do usuário ao qual os recursos pertencem.	141345906006****
CallerSource	string	O ID do usuário que fez a solicitação. Se CallerSource estiver definido como User, CallerUid indica o ID exclusivo (UID) do usuário.	141345906006****
CallerUid	string	A origem da solicitação. Valores válidos: System User	User

Exemplos

Resposta de sucesso

JSON formato

{
  "PageNumber": 1,
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****",
  "PageSize": 10,
  "TotalCount": 5,
  "Items": [
    {
      "Status": "Running",
      "TaskId": "t-83br18hloy3faf****",
      "CurrentStepName": "exec_task",
      "StartTime": "2022-02-03T11:31:03Z",
      "EndTime": "2022-02-03T12:06:17Z",
      "TaskType": "ModifyInsSpec",
      "RemainTime": 1000,
      "Progress": 79,
      "RegionId": "cn-shanghai",
      "InstanceType": "Instance",
      "InstanceId": "r-bp1zxszhcgatnx****",
      "InstanceName": "dba-tair-test-qcloud",
      "DbType": "redis",
      "Product": "kvstore",
      "TaskDetail": "{\\\"callerUid\\\":\\\"test\\\"}",
      "ReasonCode": "小版本升级",
      "ActionInfo": "{\"steps\":[{\"action_info\":{\"Waiting\":[\"modifySwitchTime\"]},\"step_name\":\"exec_task\"}]}",
      "Uid": "141345906006****",
      "CallerSource": "141345906006****",
      "CallerUid": "User"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Param.Invalid	Param invalid
400	Param.Invalid.TimeEndBeforeStart	Param invalid. End time before start time

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.