Ping the BlueXP cloud service
Suggest changes
PDFs
POST /cluster/mediator-ping
Introduced In: 9.17
Pings BlueXP cloud service.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
return_records |
boolean |
query |
False |
The default is false. If set to true, the records are returned.
|
Request Body
| Name | Type | Description |
|---|---|---|
configurable |
boolean |
Indicates if the BlueXP cloud mediator is configurable. This depends on whether the ping latency is within a threshold. |
high_latency |
boolean |
Indicates if the ping latency of the BlueXP cloud server is greater than a threshold. |
latency_ms |
integer |
Ping latency in milliseconds. |
proxy_configured |
boolean |
Indicates if the HTTP proxy is configured on the cluster for the REST API calls to the BlueXP cloud server. |
proxy_used |
boolean |
Indicates if the HTTP proxy is used for the ping to the BlueXP cloud server. |
reachable |
boolean |
Ping status of the BlueXP cloud service. |
timeout_occurred |
boolean |
Indicates if the ping to the BlueXP cloud server failed due to a timeout. |
type |
string |
Mediator type. |
Example request
{
"configurable": 1,
"high_latency": "",
"latency_ms": 150,
"proxy_configured": 1,
"proxy_used": 1,
"reachable": 1,
"timeout_occurred": "",
"type": "string"
}Response
Status: 200, Ok| Name | Type | Description |
|---|---|---|
configurable |
boolean |
Indicates if the BlueXP cloud mediator is configurable. This depends on whether the ping latency is within a threshold. |
high_latency |
boolean |
Indicates if the ping latency of the BlueXP cloud server is greater than a threshold. |
latency_ms |
integer |
Ping latency in milliseconds. |
proxy_configured |
boolean |
Indicates if the HTTP proxy is configured on the cluster for the REST API calls to the BlueXP cloud server. |
proxy_used |
boolean |
Indicates if the HTTP proxy is used for the ping to the BlueXP cloud server. |
reachable |
boolean |
Ping status of the BlueXP cloud service. |
timeout_occurred |
boolean |
Indicates if the ping to the BlueXP cloud server failed due to a timeout. |
type |
string |
Mediator type. |
Example response
{
"configurable": 1,
"high_latency": "",
"latency_ms": 150,
"proxy_configured": 1,
"proxy_used": 1,
"reachable": 1,
"timeout_occurred": "",
"type": "string"
}Error
Status: DefaultONTAP Error Response codes
| Error code | Description |
|---|---|
13369414 |
Failed to talk to the BlueXP cloud service. Check the need for an HTTP proxy and network settings like firewall. |
13369417 |
Failed to check if an HTTP proxy is configured on the cluster. |
| Name | Type | Description |
|---|---|---|
configurable |
boolean |
Indicates if the BlueXP cloud mediator is configurable. This depends on whether the ping latency is within a threshold. |
error |
||
reachable |
boolean |
Ping status of the BlueXP cloud service. |
Example error
{
"configurable": "",
"error": {
"message": "string"
},
"reachable": ""
}Definitions
See Definitions
mediator_ping
BlueXP cloud service ping API.
| Name | Type | Description |
|---|---|---|
configurable |
boolean |
Indicates if the BlueXP cloud mediator is configurable. This depends on whether the ping latency is within a threshold. |
high_latency |
boolean |
Indicates if the ping latency of the BlueXP cloud server is greater than a threshold. |
latency_ms |
integer |
Ping latency in milliseconds. |
proxy_configured |
boolean |
Indicates if the HTTP proxy is configured on the cluster for the REST API calls to the BlueXP cloud server. |
proxy_used |
boolean |
Indicates if the HTTP proxy is used for the ping to the BlueXP cloud server. |
reachable |
boolean |
Ping status of the BlueXP cloud service. |
timeout_occurred |
boolean |
Indicates if the ping to the BlueXP cloud server failed due to a timeout. |
type |
string |
Mediator type. |
error
| Name | Type | Description |
|---|---|---|
code |
integer |
Error code. |
message |
string |
Error message string. |