List resources for a given instruction, to be shown to/executed by users.

For restore operations requiring user input e.g. performing an action,
accepting/rejecting an action, etc. the information to be conveyed to users
is provided in this call.

Request:

Method:

GET

URI Path(s):

/api/v1/cluster/restore/instruction-resources

Request Headers:

n/a

Query Parameters:

ActionableResourceListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
instruction_id	Id of the instruction set whose instructions are to be returned	string	Required
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/cluster/restore/instruction-resources ?instruction_id=48F45150-038C-4664-B468-36FFE1B356F9

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ActionableResourceListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List results	array of ActionableResource	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "result_count": 2, "cursor": "00361b9f1d54-2f05-441e-9851-c42518cc8b1dasdfds", "results": [ { "id": "4630aadd-25d7-4c73-b03c-227ac314dfc4", "display_name": "db-server", "resource_type": "FabricNode", "ip_address": "10.23.12.77" }, { "id": "3cc5e971-0329-4f35-966a-7cd879171688", "display_name": "app-server", "resource_type": "FabricNode", "ip_address": "10.23.12.78" } ] }

List resources for a given instruction, to be shown to/executed by users.

Request:

ActionableResourceListRequestParameters (schema)

Example Request:

Successful Response:

ActionableResourceListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: