Skip to main content
Astra Automation
Uma versão mais recente deste produto está disponível.
O português é fornecido por meio de tradução automática para sua conveniência. O inglês precede o português em caso de inconsistências.

Recuperar uma tarefa

PDFs

GET /accounts/{account_id}/core/v1/tasks/{task_id}

Retorna o recurso da API de Tarefas armazenado no corpo da resposta JSON.

Parâmetros

Nome Tipo Em Obrigatório Descrição

id_da_conta

string

caminho

Verdadeiro

ID do recurso de conta que o contém

  • exemplo: {{.Account}}

id_da_tarefa

string

caminho

Verdadeiro

ID da coleção de tarefas a ser listada

Resposta

Status: 200, Returns the stored Task API resource in the JSON response body.
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

Tipo de mídia do recurso. Os valores definidos são:

  • "application/astra-task"

versão

string

Verdadeiro

Versão do recurso. Os valores definidos são:

  • "1,0"

  • "1,1"

id

string

Verdadeiro

Identificador globalmente único do recurso. Os valores definidos são:

  • Em conformidade com o esquema UUIDv4

nome

string

Verdadeiro

String JSON contendo um nome hierárquico para a tarefa, delimitado por um ponto (.). Os valores definidos são:

  • Comprimento mínimo: 3

  • Comprimento máximo: 127

  • Regex definido é: "^[a-z])(\.([a-z])+$"

resumo

string

Verdadeiro

String JSON contendo o resumo da tarefa em formato abreviado. Os valores definidos são:

  • Comprimento mínimo: 3

  • Comprimento máximo: 63

descrição

string

Verdadeiro

String JSON contendo uma descrição da tarefa. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 511

serviço

string

Falso

String JSON contendo o nome do serviço que está gerenciando a tarefa. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 31

ID da tarefa pai

string

Falso

String JSON contendo um identificador globalmente único da tarefa pai da tarefa. Os valores definidos são:

  • Conforme o esquema de identificador Astra

ID do usuário

string

Falso

String JSON contendo o ID do usuário associado a uma tarefa. Incluída apenas para tarefas associadas a ações iniciadas pelo usuário. Os valores definidos são:

  • Conforme o esquema de identificador Astra

ID do recurso

string

Verdadeiro

String JSON contendo um identificador globalmente único do recurso associado à tarefa. Os valores definidos são:

  • Conforme o esquema de identificador Astra

URI de recurso

string

Verdadeiro

String JSON contendo o URI associado à tarefa. Os valores definidos são:

  • Comprimento mínimo: 3

  • Comprimento máximo: 4095

URI da Coleção de Recursos

array[string]

Verdadeiro

Matriz JSON de strings JSON, cada uma indicando a URL de acesso completa do recurso associado à tarefa. Os valores definidos são:

  • Comprimento mínimo: 3

  • Comprimento máximo: 4095

estado

string

Verdadeiro

String JSON contendo um valor que indica o estado operacional da tarefa. Os valores definidos são:

  • "notStarted" - A tarefa ainda não começou a ser executada.

  • "Em execução" - A tarefa está em execução.

  • "Concluído" - A tarefa foi concluída.

  • "Pausando" - Foi solicitado que a tarefa fosse pausada.

  • "paused" - A tarefa está pausada.

  • "cancelando" - Foi solicitado o cancelamento da tarefa.

  • "Cancelado" - A tarefa foi cancelada.

  • "falhou" - A tarefa falhou.

  • Comprimento mínimo: 1

  • Comprimento máximo: 31

stateTransitions

array["type_astra_stateTransition"]

Verdadeiro

Matriz JSON de objetos JSON, cada um representando o conjunto de transições de estado permitidas a partir de um determinado estado definido. Cada objeto JSON contém os campos "from" e "to", onde o valor de "from" é o nome de um estado e o valor de "to" é uma matriz de estados de destino permitidos.

  • Comprimento mínimo: 1

  • Comprimento máximo: 31 Por exemplo: "stateTransitions" : [ { "from": "running", "to": ["paused", "cancelled"] }, { "from": "paused", "to": ["running", "cancelled"] }, ]

stateDetails

array["type_astra_stateDetail"]

Verdadeiro

Matriz JSON de objetos JSON que lista detalhes adicionais sobre o "estado" atual. Este campo indica quando existem condições ou erros que impedem que o estado atual corresponda ao estado desejado. Se não houver detalhes disponíveis, essa matriz estará vazia.

  • Quantidade mínima de itens: 0

orderHint

número

Falso

Número JSON que representa a ordem das subtarefas. Este campo pode ser usado pelo cliente para classificar as subtarefas da menor para a maior.

percentDone

número

Falso

Número JSON contendo a porcentagem de conclusão de uma tarefa em execução. Quando a tarefa é concluída, esse valor é definido como "100".

startTime

string

Falso

String JSON contendo o registro de data e hora que indica quando a tarefa foi iniciada. Os valores definidos são:

  • Em conformidade com o esquema de data e hora ISO-8601

endTime

string

Falso

String JSON contendo o timestamp que indica quando a tarefa terminou. Os valores definidos são:

  • Em conformidade com o esquema de data e hora ISO-8601

cancelTime

string

Falso

String JSON contendo o registro de data e hora que indica quando a tarefa foi cancelada. Os valores definidos são:

  • Em conformidade com o esquema de data e hora ISO-8601

metadados

"tipo_metadados_astra"

Verdadeiro

Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:

  • Conforme o esquema de metadados Astra
Exemplo de resposta 
{
  "type": "application/astra-task",
  "version": "1.1",
  "id": "26e8e8ef-5549-5928-98dd-2c3d43a608e8",
  "name": "astra.backup.prep",
  "summary": "Backup preparation",
  "description": "Task to prepare for the application backup",
  "service": "nautilus",
  "userID": "abda967f-cd2c-4237-908e-99266648c553",
  "parentTaskID": "9cc8c321-6af1-406c-8158-2c6582c247f8",
  "resourceID": "626a0978-d55f-4841-8b7c-dc0c0f592c6f",
  "resourceURI": "/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/k8s/v1/apps/7c8bef49-697e-4fb4-810c-675cef4cf6c9/appSnaps/2b6dafc3-2172-4431-a482-6306b2703130",
  "resourceCollectionURI": [
    "/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/topology/v1/clouds/0df3f1a0-7203-4c12-aabf-a7bee6302671/clusters/dfd9de2d-6f0b-437b-a737-c8f7f176cd14/namespaces/f8b58091-4b9c-4c64-9b40-018dbaf7c5de/apps/f670bf11-8850-44bd-b330-815af6186a06/appSnaps/2b6dafc3-2172-4431-a482-6306b2703130",
    "/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/topology/v1/clouds/0df3f1a0-7203-4c12-aabf-a7bee6302671/clusters/dfd9de2d-6f0b-437b-a737-c8f7f176cd14/namespaces/923708f8-0435-45b5-8c00-fbdef3ffaf25/apps/f670bf11-8850-44bd-b330-815af6186a06/appSnaps/2b6dafc3-2172-4431-a482-6306b2703130"
  ],
  "state": "running",
  "stateTransitions": [
    {
      "from": "running",
      "to": [
        "paused",
        "cancelled"
      ]
    },
    {
      "from": "paused",
      "to": [
        "running",
        "cancelled"
      ]
    }
  ],
  "stateDetails": [],
  "orderHint": 0,
  "percentDone": 20.25,
  "startTime": "2020-08-06T12:24:52.256624Z",
  "endTime": "2020-08-06T12:26:52.256624Z",
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Resposta

Status: 401, Unauthorized
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso
Exemplo de resposta 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Resposta

Status: 400, Bad request
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso

invalidParams

array["invalidParams"]

Falso

Lista de parâmetros de consulta inválidos
Exemplo de resposta 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Resposta

Status: 403, Forbidden
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso
Exemplo de resposta 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Erro

Status: 404, Not found
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso
Exemplo de resposta de erro 
{
  "type": "https://astra.netapp.io/problems/1",
  "title": "Resource not found",
  "detail": "The resource specified in the request URI wasn't found.",
  "status": "404"
}

Definições

Ver definições

type_astra_stateTransition

Nome Tipo Obrigatório Descrição

de

string

Verdadeiro

para

array[string]

Verdadeiro

additionalDetails

type_astra_stateDetail

Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

additionalDetails

"additionalDetails"

Falso

tipo_astra_label

Nome Tipo Obrigatório Descrição

nome

string

Verdadeiro

valor

string

Verdadeiro

tipo_metadados_astra

Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:

  • Conforme o esquema de metadados Astra

Nome Tipo Obrigatório Descrição

etiquetas

array["tipo_astra_label"]

Verdadeiro

CriaçãoTimestamp

string

Verdadeiro

Alteração do Timestamp

string

Verdadeiro

CreatedBy

string

Verdadeiro

modifiedBy

string

Falso

invalidParams

Nome Tipo Obrigatório Descrição

nome

string

Verdadeiro

Nome do parâmetro de consulta inválido

razão

string

Verdadeiro

Motivo pelo qual o parâmetro de consulta é inválido