Enumerar todas las tareas
GET /accounts/{account_id}/core/v1/tasks
Devuelve una matriz JSON de todos los recursos coincidentes de la colección. Si se especifican campos individuales en la solicitud, la matriz JSON de elementos contendrá los campos solicitados para cada recurso coincidente en el orden especificado.
Parámetros
| Nombre | Tipo | En | Obligatorio | Descripción |
|---|---|---|---|---|
account_id |
cadena |
ruta |
Verdadero |
ID del recurso de cuenta que lo contiene
|
incluya |
cadena |
consulta |
Falso |
Indica qué campos deben devolverse al listar una colección. Ejemplos de URL: "include=id", "include=id,name" Ejemplos OpenAPI: "id" |
límite |
cadena |
consulta |
Falso |
Indica el número máximo de recursos a devolver al listar una colección. Ejemplos de URL: "limit=2" Ejemplos OpenAPI: "2" |
filtro |
cadena |
consulta |
Falso |
Indica qué campos deben coincidir para devolver un recurso al listar una colección. Los operadores admitidos son:
Ejemplo de URL: "filter=field%20eq%20%27value%27" Ejemplos OpenAPI: "field eq 'value'" |
Respuesta
Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
artículos |
array[Cualquiera de: "task_1.1_get_response_body", array[]] |
Verdadero |
|
metadatos |
Verdadero |
Ejemplo de respuesta
{
"type": "application/astra-tasks",
"version": "1.1",
"items": [
{
"type": "application/astra-task",
"version": "1.0",
"id": "ae1e6561-9e22-406c-8a5a-762f4604da00",
"name": "astra.backup.prep",
"summary": "Backup preparation",
"description": "Task to prepare for the application backup",
"service": "nautilus",
"parentTaskID": "9cc8c321-6af1-406c-8158-2c6582c247f8",
"userID": "abda967f-cd2c-4237-908e-99266648c553",
"resourceID": "626a0978-d55f-4841-8b7c-dc0c0f592c6f",
"resourceURI": "/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/k8s/v1/apps/7c8bef49-697e-4fb4-810c-675cef4cf6c9/appSnaps/5cb608f9-571b-492e-a520-5bfb900a9b9c",
"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/5cb608f9-571b-492e-a520-5bfb900a9b9c",
"/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/5cb608f9-571b-492e-a520-5bfb900a9b9c"
],
"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",
"metadata": {
"labels": [],
"creationTimestamp": "2020-08-06T12:24:52.256624Z",
"modificationTimestamp": "2020-08-06T12:24:52.256624Z",
"createdBy": "00000000-0000-0000-0000-000000000000"
}
},
{
"type": "application/astra-task",
"version": "1.0",
"id": "bc1e6561-9e22-406c-8a5a-762f4604da00",
"name": "astra.backup",
"summary": "Backup",
"description": "Task to take a Backup for an application",
"service": "nautilus",
"userID": "abda967f-cd2c-4237-908e-99266648c553",
"resourceID": "736a0978-d55f-4841-8b7c-dc0c0f592c6f",
"resourceURI": "/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/k8s/v1/apps/7c8bef49-697e-4fb4-810c-675cef4cf6c9/appBackups/736a0978-d55f-4841-8b7c-dc0c0f592c6f",
"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/appBackups/736a0978-d55f-4841-8b7c-dc0c0f592c6f",
"/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/appBackups/736a0978-d55f-4841-8b7c-dc0c0f592c6f"
],
"state": "completed",
"stateTransitions": [
{
"from": "running",
"to": [
"paused",
"cancelled"
]
},
{
"from": "paused",
"to": [
"running",
"cancelled"
]
}
],
"stateDetails": [],
"orderHint": 0,
"percentDone": 100,
"startTime": "2020-08-06T12:24:52.256624Z",
"endTime": "2020-08-06T12:26:52.256624Z",
"metadata": {
"labels": [],
"creationTimestamp": "2020-08-06T12:24:52.256624Z",
"modificationTimestamp": "2020-08-06T12:24:52.256624Z",
"createdBy": "00000000-0000-0000-0000-000000000000"
}
}
],
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
Respuesta
Status: 401, Unauthorized
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Respuesta
Status: 400, Bad request
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
|
invalidParams |
array["invalidParams"] |
Falso |
Lista de parámetros de consulta no válidos |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Respuesta
Status: 403, Forbidden
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Error
Status: 404, Not found
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta de error
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Definiciones
Ver definiciones
type_astra_stateTransition
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
de |
cadena |
Verdadero |
|
a |
array[string] |
Verdadero |
type_astra_stateDetail
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
etiqueta_tipo_astra
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
nombre |
cadena |
Verdadero |
|
valor |
cadena |
Verdadero |
tipo_astra_metadatos
Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:
-
Cumple con el esquema de metadatos Astra
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
etiquetas |
array["etiqueta_tipo_astra"] |
Verdadero |
|
CreationTimestamp |
cadena |
Verdadero |
|
Modificación.Marca de hora |
cadena |
Verdadero |
|
CreatedBy |
cadena |
Verdadero |
|
modifiedBy |
cadena |
Falso |
task_1.1_get_response_body
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
Tipo de medio del recurso. Los valores definidos son:
|
versión |
cadena |
Verdadero |
Versión del recurso. Los valores definidos son:
|
id |
cadena |
Verdadero |
Identificador único global del recurso. Los valores definidos son:
|
nombre |
cadena |
Verdadero |
Cadena JSON que contiene un nombre jerárquico en notación de puntos (.) para la tarea. Los valores definidos son:
|
resumen |
cadena |
Verdadero |
Cadena JSON que contiene el resumen abreviado de la tarea. Los valores definidos son:
|
descripción |
cadena |
Verdadero |
Cadena JSON que contiene una descripción de la tarea. Los valores definidos son:
|
servicio |
cadena |
Falso |
Cadena JSON que contiene el nombre del servicio que gestiona la tarea. Los valores definidos son:
|
parentTaskID |
cadena |
Falso |
Cadena JSON que contiene un identificador único global de una tarea padre de la tarea. Los valores definidos son:
|
userID |
cadena |
Falso |
Cadena JSON que contiene el ID de usuario asociado a una tarea. Solo se incluye para tareas asociadas a acciones iniciadas por el usuario. Los valores definidos son:
|
resourceID |
cadena |
Verdadero |
Cadena JSON que contiene un identificador único global del recurso asociado a la tarea. Los valores definidos son:
|
resourceURI |
cadena |
Verdadero |
Cadena JSON que contiene el URI asociado a la tarea. Los valores definidos son:
|
resourceCollectionURI |
array[string] |
Verdadero |
Matriz JSON de cadenas JSON, cada una de las cuales indica la URL de acceso completamente expandida del recurso asociado a la tarea. Los valores definidos son:
|
estado |
cadena |
Verdadero |
Cadena JSON que contiene un valor que indica el estado operativo de la tarea. Los valores definidos son:
|
stateTransitions |
array["type_astra_stateTransition"] |
Verdadero |
Matriz JSON de objetos JSON, cada uno de los cuales representa el conjunto de transiciones de estado permitidas desde un estado definido dado. Cada objeto JSON contiene los campos "from" y "to", donde el valor "from" es el nombre de un estado y el valor "to" es una matriz de estados de destino permitidos.
|
stateDetails |
array["type_astra_stateDetail"] |
Verdadero |
Matriz JSON de objetos JSON que enumera detalles adicionales sobre el "estado" actual. Este campo indica cuándo hay condiciones o errores que impiden que el estado real coincida con el estado deseado. Si no hay detalles disponibles, esta matriz estará vacía.
|
orderHint |
número |
Falso |
Número JSON que representa el orden de las subtareas. Este campo puede ser usado por el cliente para ordenar las subtareas de menor a mayor. |
percentDone |
número |
Falso |
Número JSON que contiene el porcentaje completado de una tarea en ejecución. Cuando la tarea se completa, esto se establece en "100". |
startTime |
cadena |
Falso |
Cadena JSON que contiene la marca de tiempo que indica cuándo se inició la tarea. Los valores definidos son:
|
endTime |
cadena |
Falso |
Cadena JSON que contiene la marca de tiempo que indica cuándo finalizó la tarea. Los valores definidos son:
|
cancelTime |
cadena |
Falso |
Cadena JSON que contiene la marca de tiempo que indica cuándo se canceló la tarea. Los valores definidos son:
|
metadatos |
Verdadero |
Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:
|
type_astra_metadata_list
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
continuar |
cadena |
Falso |
|
cuente |
número |
Falso |
|
etiquetas |
array["etiqueta_tipo_astra"] |
Falso |
|
CreationTimestamp |
cadena |
Falso |
|
Modificación.Marca de hora |
cadena |
Falso |
|
CreatedBy |
cadena |
Falso |
|
modifiedBy |
cadena |
Falso |
invalidParams
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
nombre |
cadena |
Verdadero |
Nombre del parámetro de consulta no válido |
motivo |
cadena |
Verdadero |
Razón por la que el parámetro de consulta no es válido |