Obtenção de informações de tarefa de uma instância de banco de dados do SQL Server especificada em um intervalo de tempo especificado
Função
Esta API é usada para obter a lista de informações de tarefas de um ID de instância de banco de dados do SQL Server especificado dentro de um intervalo de tempo especificado.
- Antes de chamar uma API, você precisa entender a API em Autenticação.
Restrições
- Esta API é usada para consultar tarefas assíncronas do último mês no centro de tarefas.
- Informações das seguintes tarefas assíncronas podem ser obtidas: criação de instâncias de banco de dados únicas ou primárias/em espera, criação de réplicas de leitura, alteração de instâncias de banco de dados únicas para instâncias primárias/em espera, alternância de instâncias de banco de dados primárias/em espera, ampliação do espaço de armazenamento, criação de backups automáticos ou manuais, restauração de dados para instâncias de banco de dados originais, existentes ou novas.
URI
- Formato de URI
GET /v3/{project_id}/instances/{instance_id}/tasklist/detail?start_time={start_time}&end_time={end_time}
- Descrição do parâmetro
Tabela 1 Descrição do parâmetro Nome
Obrigatório
Descrição
project_id
Sim
Especifica o ID do projeto de um locatário em uma região.
Para obter detalhes sobre como obter o ID do projeto, consulte Obtenção de um ID de projeto.
instance_id
Sim
Especifica o ID da instância de banco de dados.
start_time
Sim
Especifica a hora de início no formato de carimbo de data/hora UTC.
end_time
Não
Especifica a hora de término no formato de carimbo de data/hora UTC.
Solicitação
Resposta
- Resposta normal
Tabela 2 Descrição do parâmetro Nome
Tipo
Descrição
jobs
Object
Indica as informações da tarefa. Para mais detalhes, consulte Tabela 3.
count
Integer
Indica o número total de tarefas.
Tabela 3 Descrição da estrutura de dados do campo jobs Nome
Tipo
Descrição
id
String
Indica o ID da tarefa.
name
String
Indica o nome da tarefa.
status
String
Indica o status de execução da tarefa.
Valor:- Running: a tarefa está sendo executada.
- Completed: a tarefa foi executada com sucesso.
- Failed: a tarefa falhou ao ser executada.
created
String
Indica o tempo de criação no formato "yyyy-mm-ddThh:mm:ssZ".
T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.
ended
String
Indica a hora de fim no formato "yyyy-mm-ddThh:mm:ssZ".
T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.
process
String
Indica o andamento da execução da tarefa.
NOTA:O progresso da execução (como "60", indicando que o andamento da execução da tarefa é de 60%) é exibido somente quando a tarefa está sendo executada. Caso contrário, "" é retornado.
instance
Object
Indica informações da instância de banco de dados na qual a tarefa é executada.
Para mais detalhes, consulte Tabela 4.
task_detail
String
As informações exibidas variam dependendo das tarefas.
Para obter detalhes, consulte o seguinte:
NOTA:este campo não é exibido para tarefas assíncronas que não contenham o campo task_detail.
fail_reason
String
Indica as informações de erro exibidas quando uma tarefa falhou.
entities
Object
As informações exibidas variam dependendo das tarefas.
Tabela 4 Descrição da estrutura de dados do campo instance Nome
Tipo
Descrição
id
String
Indica o ID da instância de banco de dados.
name
String
Indica o nome da instância de banco de dados.
Tabela 5 Descrição da estrutura de dados do campo task_detail (restauração de dados para instâncias de banco de dados originais, existentes ou novas, ou restauração de dados no nível da tabela para um ponto de tempo especificado) Nome
Tipo
Descrição
sourceInstanceId
String
Indica o ID da instância de banco de dados original para a qual os dados de backup são restaurados.
targetInstanceId
String
Indica o ID da instância de banco de dados de destino para a qual os dados de backup são restaurados.
backupId
String
Indica o ID do arquivo de backup.
restoreTime
String
Indica o ponto de tempo para o qual os dados de nível de tabela são restaurados.
type
String
Indica o tipo de tarefa.
dbNames
List<String>
Indica o nome do banco de dados.
Tabela 6 Descrição da estrutura de dados do campo task_detail (criação de backups automáticos ou manuais) Nome
Tipo
Descrição
instanceId
String
Indica o ID da instância de banco de dados a ser feita o backup.
name
String
Indica o nome da tarefa.
description
String
Indica a descrição da tarefa.
dbNames
String
Indica o nome dos dados a serem copiados.
No exemplo de resposta, alguns detalhes da tarefa retornados são usados como exemplos.
- Exemplo de resposta normal
Criação de backups automáticos ou manuais:
{ "jobs": [ { "id": "aa4e3386-af27-436e-99f5-7cfefa21c37a", "name": "BackupDbSqlserverInInstance", "status": "Completed", "created": "2020-07-20T16:10:07+0000", "ended": "2020-07-20T16:14:39+0000", "process": "", "instance": { "id": "9a09052dfa824caea36f583bc3e5684ein04", "name": "rds-8d43-0004" }, "task_detail": "{\"instanceId\":\"9a09052dfa824caea36f583bc3e5684ein04\",\"name\":\"sqlserver-rds-8d43-0004-20200719161130675\"}" } ], "count":1 }Restauração de dados para instâncias de banco de dados originais, existentes ou novas, ou restauração de dados ao nível de tabela para um ponto de tempo especificado:{ "jobs": [ { "id": "11bef2cb-2924-4727-a9c2-b6fec61fc03a", "name": "SingleDbRestoreSqlserverInInstance", "status": "Failed", "created": "2020-07-21T01:38:00+0000", "ended": "2020-07-21T01:39:59+0000", "process": "", "instance": { "id": "9a09052dfa824caea36f583bc3e5684ein04", "name": "rds-8d43-0004" }, "task_detail": "{\"backupId\":\"83c76e6852c145779dc153d8299ee0e1br04\",\"dbNames\":\"backeeeeee\",\"sourceInstanceId\":\"9a09052dfa824caea36f583bc3e5684ein04\",\"targetInstanceId\":\"9a09052dfa824caea36f583bc3e5684ein04\"}" } ], "count":1 }Outros tipos de tarefas:{ "jobs":[ { "id":"11bef2cb-2924-4727-a9c2-b6fec61fc03a", "name":"SingleDbRestoreSqlserverInInstance", "status":"Complete", "created":"2020-07-21T01:38:00+0000", "ended":"2020-07-21T01:39:59+0000", "process":"", "instance":{ "id":"9a09052dfa824caea36f583bc3e5684ein04", "name":"rds-8d43-0004" } } ], "count":1 }Tarefa que está sendo executada:{ "jobs":[ { "id": "32291a2e-882b-4266-b7c0-89dae34d2a9d", "name": "CreateSqlserverSingleHAInstance", "status": "Running", "created": "2020-07-14T15:02:29+0000", "ended": "2020-07-14T15:16:18+0000", "process": "50", "instance": { "id": "9a09052dfa824caea36f583bc3e5684ein04", "name": "rds-8d43-0004" } } ], "count":1 }Tarefa falha ao ser executada:{ "jobs":[ { "id": "32291a2e-882b-4266-b7c0-89dae34d2a9d", "name": "CreateSqlserverSingleHAInstance", "status": "Failed", "created": "2020-07-14T15:02:29+0000", "ended": "2020-07-14T15:16:18+0000", "process": "", "instance": { "id": "9a09052dfa824caea36f583bc3e5684ein04", "name": "rds-8d43-0004" }, "fail_reason": "createVM failed." } ], "count":1 } - Resposta anormal
Para mais detalhes, consulte Resultados anormais da solicitação.
Código de status
- Normal
- Anormal
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.
