Skip to content

Commit

Permalink
docs: detail node list API and CLI pagination and filtering info.
Browse files Browse the repository at this point in the history
  • Loading branch information
jrasell committed Apr 21, 2022
1 parent baa4bd5 commit 307ef09
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
14 changes: 14 additions & 0 deletions website/content/api-docs/nodes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,20 @@ The table below shows this endpoint's support for
number of hexadecimal characters (0-9a-f). This is specified as a query
string parameter.

- `next_token` `(string: "")` - This endpoint supports paging. The `next_token`
parameter accepts a string which identifies the next expected node. This
value can be obtained from the `X-Nomad-NextToken` header from the previous
response.

- `per_page` `(int: 0)` - Specifies a maximum number of nodes to return for
this request. If omitted, the response is not paginated. The value of the
`X-Nomad-NextToken` header of the last response can be used as the
`next_token` of the next request to fetch additional pages.

- `filter` `(string: "")` - Specifies the [expression](/api-docs#filtering)
used to filter the results. Consider using pagination or a query parameter to
reduce resource used to serve the request.

- `resources` `(bool: false)` - Specifies whether or not to include the
`NodeResources` and `ReservedResources` fields in the response.

Expand Down
6 changes: 6 additions & 0 deletions website/content/docs/commands/node/status.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ capability.

- `-verbose`: Show full information.

- `-per-page`: How many results to show per page.

- `-page-token`: Where to start pagination.

- `-filter`: Specifies an expression used to filter query results.

- `-os`: Display operating system name.

- `-quiet`: Display only node IDs.
Expand Down

0 comments on commit 307ef09

Please sign in to comment.