Get Enterprise Profile QOS
Fetch profile-level QOS module for a customer
The logicalId
GUID for the target enterprise
The logicalId
GUID for the target profile
A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.
Request successfully processed
{
"serviceRateLimit": {
"enabled": false,
"inputType": "string",
"value": 0
},
"segments": [
{
"rules": [
{
"name": "string",
"match": {
"appid": 0,
"classid": 0,
"application": {
"_href": "string",
"name": "string",
"displayName": "string",
"class": 0,
"description": "string",
"knownIpPortMapping": {},
"protocolPortMapping": {},
"mustNotPerformDpi": 0
},
"applicationClass": {
"_href": "string",
"id": "number",
"name": "string"
},
"dscp": 0,
"sip": "string",
"sport_high": 0,
"sport_low": 0,
"sAddressGroup": "string",
"sPortGroup": "string",
"ssm": "string",
"svlan": 0,
"sInterface": "string",
"os_version": 0,
"hostname": "string",
"dip": "string",
"dport_low": 0,
"dport_high": 0,
"dAddressGroup": "string",
"dPortGroup": "string",
"dsm": "string",
"dvlan": 0,
"dInterface": "string",
"proto": 0,
"s_rule_type": "string",
"d_rule_type": "string",
"ipVersion": "string",
"sipV6": "string",
"dipV6": "string"
},
"action": {
"routePolicy": "string",
"routeType": "string",
"allowConditionalBh": false,
"userDisableConditionalBh": false,
"edge2EdgeRouteAction": {
"interface": "string",
"linkInternalLogicalId": "string",
"link": {
"_href": "string"
},
"linkPolicy": "string",
"routeCfg": {},
"routePolicy": "string",
"serviceGroup": "string",
"vlanId": 0,
"wanlink": "string",
"wanLinkName": "string",
"subinterfaceId": 0,
"linkCosLogicalId": "string",
"linkOuterDscpTag": "string",
"linkInnerDscpTag": "string"
},
"edge2DataCenterRouteAction": {
"interface": "string",
"linkInternalLogicalId": "string",
"link": {
"_href": "string"
},
"linkPolicy": "string",
"routeCfg": {},
"routePolicy": "string",
"serviceGroup": "string",
"vlanId": 0,
"wanlink": "string",
"wanLinkName": "string",
"subinterfaceId": 0,
"linkCosLogicalId": "string",
"linkOuterDscpTag": "string",
"linkInnerDscpTag": "string"
},
"edge2CloudRouteAction": {
"interface": "string",
"linkInternalLogicalId": "string",
"link": {
"_href": "string"
},
"linkPolicy": "string",
"routeCfg": {},
"routePolicy": "string",
"serviceGroup": "string",
"vlanId": 0,
"wanlink": "string",
"wanLinkName": "string",
"subinterfaceId": 0,
"linkCosLogicalId": "string",
"linkOuterDscpTag": "string",
"linkInnerDscpTag": "string"
},
"QoS": {},
"sla": {},
"natIpVersion": "string",
"nat": {
"sourceIp": "string",
"destIp": "string"
},
"natV6": {
"sourceIp": "string",
"destIp": "string"
}
},
"ruleLogicalId": "string"
}
],
"defaults": [
{}
],
"webProxy": {
"providers": [
{}
]
},
"segment": {
"_href": "string",
"created": "string",
"description": "string",
"object": "string",
"name": "string",
"type": "string",
"alertsEnabled": 0,
"operatorAlertsEnabled": 0,
"status": "string",
"statusModified": "string",
"previousData": {},
"previousCreated": "string",
"draftData": "string",
"draftCreated": "string",
"draftComment": "string",
"data": {},
"lastContact": "string",
"version": "string",
"modified": "string"
},
"cosMapping": {
"lsInputType": "string",
"bulk": {
"high": {
"value": 0,
"ratelimit": false
},
"normal": {
"value": 0,
"ratelimit": false
},
"low": {
"value": 0,
"ratelimit": false
}
},
"realtime": {
"high": {
"value": 0,
"ratelimit": false
},
"normal": {
"value": 0,
"ratelimit": false
},
"low": {
"value": 0,
"ratelimit": false
}
},
"transactional": {
"high": {
"value": 0,
"ratelimit": false
},
"normal": {
"value": 0,
"ratelimit": false
},
"low": {
"value": 0,
"ratelimit": false
}
}
}
}
],
"qoe": {
"voice": {
"latency": {
"yellow": 0,
"red": 0
}
},
"video": {
"latency": {
"yellow": 0,
"red": 0
}
},
"transactional": {
"latency": {
"yellow": 0,
"red": 0
}
}
}
}
ValidationError
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string",
"errors": [
{
"message": "string",
"path": "string"
}
]
}
A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation
Unauthorized
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string"
}
A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation
Resource not found
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string"
}
A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation
Rate Limit Exceeded
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string"
}
A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation
Internal server error
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string"
}
A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation