Node Availability

This Public Stable API method allows the Load Balancer to monitor the health of the PCE core nodes in a 2x2 or 4x2 cluster. This feature is only available if the PCE is deployed as software in your data center.

Note

This API call does not require authentication.

URI to Check Node Availability

GET [api_version]/node_available

Check Node Availability

-X GET and authentication are not required for this method. The curl -v flag provides verbose output.

curl -v https://pce.my-company.com:8443/api/v2/node_available

Or, you can use -i -X GET to return a 200 OK status if the node is available:

curl -i -X GET https://pce.my-company.com:8443/api/v2/node_available

Returns 200 OK if the core node is healthy, and it can see at least one of each service running in the PCE cluster.

Otherwise, it returns a 404 error.

For example, if the PCE is healthy and accessible, the response is 200 OK.

Health Check from a Load Balancer

In a production deployment, customers run health checks from a Load Balancer. The actual request syntax varies, but here is a sample command for Infoblox:

GET /api/v2/node_available HTTP/1.1

Support Bundle Requests

Several APIs have been introduced to provide a mechanism to generate a support bundle on each node, including a time range and possibly additional options.

API Methods

Functionality	HTTP	URI
Return the collection of PCE support bundle requests:	`GET`	`[api_version][org_href]/support_bundle_requests`
Return a specific PCE support bundle request.	`GET`	`[api_version][org_href]/support_bundle_requests/:uuid`
Create a PCE support bundle request.	`POST`	`[api_version][org_href]/support_bundle_requests`
Delete the PCE support bundle request.	`DELETE`	`[api_version][org_href]/support_bundle_requests/:uuid`

Parameters for Support Bundle Requests

Parameter	Description	Type	Required
`name`	(GET) The name of the support bundle	String	Yes
`download_url`	(GET) User-assigned description of the container cluster.	URL	Yes
`requested_at`	(GET) Time support bundle requested	string(date-time)	Yes
`completed_at`	(GET) Time support bundle completed	string,null(date-time)	Yes
`status`	(GET) A status annunciator indicating the state of this request	String	Yes
`include_logs`	(GET, POST) Set to true if logs are to be included	Boolean	Yes
`starting_at`	(GET, POST) Start date for log filtering	string,null(date-time)	Yes
`ending_at`	(GET, POST) End date for log filtering.	string,null(date-time)	Yes

Example for POST

{
	"include_logs": true,
	"starting_at": null,
	"ending_at": null
}

REST APIs for 22.2