appliance networking routes: test
Test connection to a list of gateways. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Request:
HTTP request
POST https://{server}/rest/appliance/networking/routes?action=test
Request Body Structure:
{
"gateways" : [
"string",
"string"
]
}
"gateways" : [
"string",
"string"
]
}
Request Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| gateways | string[] | list of gateways. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : {
"route_status" : [
{
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"status" : "FAILURE"
},
{
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"status" : "FAILURE"
}
],
"overall_status" : "PARTIAL_FAILED"
}
}
"value" : {
"route_status" : [
{
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"status" : "FAILURE"
},
{
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"status" : "FAILURE"
}
],
"overall_status" : "PARTIAL_FAILED"
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | test_status | connection status. |
| value.overall_status | string | Overall status of tests run. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Health indicator. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: PARTIAL_FAILED: In case data has more than one test, this indicates not all tests were successful. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. SUCCESSFUL: All tests were successful for given data. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. FAILED: All tests failed for given data. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| value.route_status | route_status[] | messages. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| value.route_status[].message | localizable_message | message. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| value.route_status[].message.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| value.route_status[].message.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| value.route_status[].message.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | Generic error |