Retrieve a Task | NVIDIA Infra Controller

Get a Task by UUID.

The same handler is also mounted at /v2/org/{org}/nico/rack/task/{id} for backward compatibility; prefer this path for new clients.

Tasks are site-scoped; siteId must be the Site where the task was created. Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

Get a Task by UUID.

The same handler is also mounted at /v2/org/{org}/nico/rack/task/{id} for backward compatibility; prefer this path for new clients.

Tasks are site-scoped; siteId must be the Site where the task was created. Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

Authentication

AuthorizationBearer

``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired

Name of the Org

idstringRequiredformat: "uuid"

UUID of the Task

Query parameters

siteIdstringRequiredformat: "uuid"

ID of the Site that owns the task (tasks are site-scoped).

Response

idstringformat: "uuid"

Unique identifier of the task.

statusenum

Current state of the task.

descriptionstring

Human-readable description provided when the task was created.

messagestring

Optional status or error message describing the current state or result.

starteddatetime

Timestamp when the task started execution.

finisheddatetime

Timestamp when the task finished (succeeded, failed or terminated).

createddatetime

Timestamp when the task was created.

updateddatetime

Timestamp when the task was last updated.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

export JWT_BEARER_TOKEN="<jwt-bearer-token>"
# Example org name: "acme-inc
export ORG_NAME=<org-name>
# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

ID of the Site that owns the task (tasks are site-scoped).

Unique identifier of the task.

Current state of the task.

Human-readable description provided when the task was created.

Optional status or error message describing the current state or result.

Timestamp when the task started execution.

Timestamp when the task finished (succeeded, failed or terminated).

Timestamp when the task was created.

Timestamp when the task was last updated.

export JWT_BEARER_TOKEN="<jwt-bearer-token>"
# Example org name: "acme-inc
export ORG_NAME=<org-name>
# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

1	{
2	"id": "550e8400-e29b-41d4-a716-446655440000",
3	"status": "Running",
4	"description": "Power on rack components",
5	"message": "Processing 3 of 5 components"
6	}

1	{
2	"id": "550e8400-e29b-41d4-a716-446655440000",
3	"status": "Running",
4	"description": "Power on rack components",
5	"message": "Processing 3 of 5 components"
6	}

$	curl -G https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/task/id \
>	-H "Authorization: Bearer <token>" \
>	-d siteId=siteId