Return more Node attributes from Node list api endpoint

[jeffawang]

Proposal

I'd like the node list endpoint to return more node attributes by allowing me to specify them in the query parameters.

Currently, I can pass os=true to /v1/nodes, and the api response returns a mapping! Currently it only reports os.name, but in my use case, I want to get the unique node identifiers, such as unique.platform.aws.instance-id.

Looking at the code here, it looks to me like os.name is hard-coded as the only "key attribute" available in this list.

Use-cases

I want to list nodes and get their aws instance ID, so that I can join it with another dataset from the AWS API.

Attempted Solutions

For now, I'm just calling the list endpoint, then iterating over all the nodes individually.

Specifically, I have been calling the api with the official go client, as well as the CLI via nomad operator api '/v1/nodes?os=true'.

I'd love to be able to do something like nomad operator api '/v1/nodes?unique=true' to instruct the API to return attributes such as unique.platform.aws.instance-id.

Or, if that is too complicated or the query parameter namespace is too crowded, just returning all of the node attributes would work for me.

[tgross]

We've had similar requests in the past (ex #20252) and ultimately this feels like the sort of thing we need some kind of query language for (without getting into the mess that is GraphQL). Node attributes can be almost arbitrarily large. I sort of wonder if we want to have an endpoint that allows for query full node data (not the "stub" that the list endpoint provides) with filtering capabilities.

[jeffawang]

… I sort of wonder if we want to have an endpoint that allows for query full node data (not the "stub" that the list endpoint provides) with filtering capabilities.

This would also work for my use case! It’s what I ended up simulating with a loop in my program.