Obtenção de informações sobre uma tarefa com um ID especificado
Descrição
Essa API é usada para obter informações sobre uma tarefa com um ID especificado no centro de tarefas.
Restrições
- Atualmente, somente as tarefas assíncronas no centro de tarefas do DDS Community Edition dentro de um mês podem ser consultadas.
- Depois que um trabalho é gerado, leva vários segundos para consultar o ID do trabalho.
- As seguintes tarefas assíncronas podem ser consultadas: criação de uma instância (nó único, conjunto de réplicas ou cluster), expansão do armazenamento, alteração da classe da instância, expansão de um nó, reinicialização de um nó, realização de um switchover principal/em espera, alteração de um endereço IP privado, alteração de um grupo de segurança, alteração de uma porta de banco de dados, vinculação ou desvinculação de um EIP, alteração do modo SSL e alteração de uma AZ, habilitação do endereço IP de shard/config, criação de um backup físico/backup de snapshot, restauração para uma nova instância usando um backup, recuperação para o ponto de tempo e restauração ao nível de banco de dados/tabela para um ponto de tempo especificado.
Depuração
Você pode depurar essa API no API Explorer.
URI
Solicitações
Descrição do parâmetro
Nome |
Tipo |
IN |
Obrigatório |
Descrição |
|---|---|---|---|---|
x-auth-token |
string |
header |
Sim |
Token do usuário |
project_id |
string |
path |
Sim |
O ID do projeto de um locatário em uma região. Para obter o ID do projeto, consulte Obtenção de um ID de projeto. |
id |
string |
query |
Sim |
A ID da tarefa. |
Respostas
- Resposta normal
Tabela 2 Descrição do parâmetro Nome
Tipo
Obrigatório
Descrição
job
Object
Sim
Informações sobre a tarefa. Para mais detalhes, consulte Tabela 3.
Tabela 3 Descrição da estrutura de dados do campo job Nome
Tipo
Obrigatório
Descrição
id
String
Sim
ID da tarefa
name
String
Sim
Nome da tarefa
status
String
Sim
Status de execução da tarefa
Valor válido:- Running: a tarefa está sendo executada.
- Completed: a tarefa foi executada com sucesso.
- Failed: a tarefa não consegue ser executada.
created
String
Sim
Tempo de criação no formato "aaaa-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.
ended
String
Sim
Hora de fim no formato "aaaa-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.
progress
String
Sim
Progresso 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
Sim
Instância na qual a tarefa é executada.
Para mais detalhes, consulte Tabela 4.
fail_reason
String
Sim
Informações sobre falha de tarefa.
Tabela 4 Descrição da estrutura de dados do campo instance Nome
Tipo
Obrigatório
Descrição
id
String
Sim
ID da instância
name
String
Sim
Nome da instância de banco de dados
No exemplo de resposta, algumas tarefas no centro de tarefas são usadas como exemplos.
- Exemplo de resposta normal
Uma tarefa foi executada com sucesso.
{ "job": { "id": "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae", "name": "Create_MongoDB", "status": "Completed", "created": "2021-07-12T09:22:04+0000", "ended": "2021-07-12T10:10:13+0000", "progress": "", "instance": { "id": "d87f5b33049144ec95f0cab0a5f22cfbin02", "name": "dds-5ff4-sh" }, "fail_reason": null } }Uma tarefa está sendo executada:
{ "job": { "id": "9d10bfd1-affb-49c3-b977-298950a8d6fa", "name": "Create_MongoDB", "status": "Running", "created": "2021-07-13T07:28:43+0000", "ended": "2021-07-13T07:28:53+0000", "progress": "9%", "instance": { "id": "cf538a2dd8ec4b26860b27060902712fin02", "name": "dds-3a98-wcc" }, "fail_reason": null } }Uma tarefa não pode ser executada:
{ "job": { "id": "a03b1b8a-b756-467c-8a49-38720c3d23ec", "name": "Restore_MongoDB_Replica", "status": "Failed", "created": "2021-07-13T04:55:58+0000", "ended": "2021-07-13T05:20:04+0000", "progress": "", "instance": { "id": "7beb15d5db9c4742b7c817789244844ein02", "name": "lenn-v3-restore-4" }, "fail_reason": "Failed to upgrade the DB Agent." } }
SDK
Clique em SDK do Document Database Service DDS para fazer download do SDK ou exibir o documento do SDK. Para saber como instalar e autenticar um SDK, leia a seção Uso.
Código de status
Para obter mais informações, consulte Código de status.
Código de erro
Para obter mais informações, consulte Código de erro.
