Workload Settings
This Public Stable API allows you to get network interface information from a workload, for either all interfaces on a workload or an individual interface. You can also configure (create) or delete an individual network interface configuration.
Get Workload Settings
Parameters for GET
Parameter | Description | Type | Requiured |
|---|---|---|---|
| Organization | Integer | Yes |
If the VEN doesn't send a heartbeat to the PCE within the value specified in workload_disconnected_timeout_seconds, the workload associated with the VEN is considered to be offline.
If the VEN goes down, it sends a goodbye message to the PCE. The PCE then waits for the value set in workload_goodbye_timeout_seconds before setting the workload to offline.
To disable workload_disconnected_timeout_seconds or workload_goodbye_timeout_seconds, set the its value to -1.
Example JSON Response Body
{
"workload_disconnected_timeout_seconds": [
{
"scope": [
{ "href": "/api/v2/orgs/1/labels/1" },
{ "href": "/api/v2/orgs/1/labels/3" }
],
"value": -1 # never
},
{
"scope": [ ], # Empty scope is the default.
Each setting must have a default.
"value": 7200 # customer-supplied default
}
],
"workload_goodbye_timeout_seconds": [
{
"scope": [
{ "href": "/api/v2/orgs/1/labels/2" },
{ "href": "/api/v2/orgs/1/labels/4" }
],
"value": 60
},
{
"scope": [ ], # Empty scope is the default.
Each setting must have a default.
"value": 0 # customer-supplied default
}
]
}Update Workload Settings
This API updates workload settings.
Parameters for PUT
Parameter | Description | Type | Requiured |
|---|---|---|---|
| Organization | Integer | Yes |
| Scope | Object | Yes |
| Label URI | String | Yes |
| Property value associated with the scope | Integer | Yes |
| Assigned labels Label URI Property value associated with the scope | Object String Integer | Yes Yes Yes |
| none | Object | No |
Example JSON Request Body to Update Both Workload Settings
{
"workload_disconnected_timeout_seconds": [
{
"scope": [ ], # Empty scope is the default.
Each setting must have a default.
"value": 3600 # customer-supplied default
}
],
"workload_goodbye_timeout_seconds": [
{
"scope": [
{ "href": "/api/v2/orgs/1/labels/1" },
{ "href": "/api/v2/orgs/1/labels/3" }
],
"value": 1800
},
{
"scope": [
{ "href": "/api/v2/orgs/1/labels/2" },
{ "href": "/api/v2/orgs/1/labels/4" }
],
"value": 60
},
{
"scope": [ ], # Empty scope is the default.
Each setting must have a default.
"value": 0 # customer-supplied default
}
]
}Example JSON Request Body to Update One Workload Setting
{
"workload_goodbye_timeout_seconds": [
{
"scope": [
{ "href": "/api/v2/orgs/1/labels/2" },
{ "href": "/api/v2/orgs/1/labels/4" }
],
"value": 120
},
{
"scope": [ ], # Empty scope is the default.
Each setting must have a default.
"value": 0 # customer-supplied default.
}
]
}