- Created by Kevin Luehrs, last modified on Oct 12, 2015
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 11 Current »
Overview
The OPNFV Connectivity Services LSO project (short name LSOAPI) is a project being run within the Linux Foundation open source project Open Platform for NFV (OPNFV). The LSOAPI project was created to develop open standard APIs exposing capabilities of open source SDN controller platforms to configure networked elements to provide business services.
The LSOAPI project wiki is accessed via the link below. The project description, objectives, documentation and other applicable information is provided on the wiki page. The exception is the API documentation in HTML format, which is hosted in this space. At the time of this writing we are not aware of availability of a web server provided by the Linux Foundation for sharing project documentation in HTML format so are providing the documentation in CableLabs wiki space.
LSOAPI project main wiki page: https://wiki.opnfv.org/lsoapi
LSOAPI project documentation wiki page: https://wiki.opnfv.org/lsoapi/documents
Connectivity Services LSO Project API Documentation version v1
http://lsoapi-server
CRUD Instances of MEF Defined Services
CRUD Instances of MEF Defined Services
CRUD Instances MEF EPL Service, returns JSON representing created EPL instance
post
Create an new EPL instance
post /svcmgr/webapi/svc/epl
Create an new EPL instance
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"numCustLocations": {
"required": true,
"type": "long"
},
"custAddressList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniHostMacList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniHostIpList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"cos": {
"required": true,
"type": "long"
},
"evcId": {
"required": true,
"type": "long"
}
}
Example:
{
"id": "epl-1",
"numCustLocations": 2,
"custAddressList": [
"1111 MEF Dr, Honolulu HI, USA",
"2222 UNI Dr, Boston MA, MAS"
],
"uniHostMacList": [
"00:B0:95:9d:68:16",
"00:A0:C9:14:C8:29"
]
"uniHostIpList": [
"192.168.1.10",
"192.168.1.11"s
],
"cos": "gold",
"evcId": "evc-1",
}
HTTP status code 200
JSON representing created EPL instance
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"numCustLocations": {
"required": true,
"type": "long"
},
"custAddressList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniHostMacList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniHostIpList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"cos": {
"required": true,
"type": "long"
},
"evcId": {
"required": true,
"type": "long"
}
}
Example:
{
"id": "epl-1",
"numCustLocations": 2,
"custAddressList": [
"1111 MEF Dr, Honolulu HI, USA",
"2222 UNI Dr, Boston MA, MAS"
],
"uniHostMacList": [
"00:B0:95:9d:68:16",
"00:A0:C9:14:C8:29"
]
"uniHostIpList": [
"192.168.1.10",
"192.168.1.11"s
],
"cos": "gold",
"evcId": "evc-1",
}
put
Modify an existing EPL instance
get
Query an existing EPL instance
delete
delete an existing EPL instance
put /svcmgr/webapi/svc/epl/{eplid}
Modify an existing EPL instance
URI Parameters
- eplid: required (string)
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"numCustLocations": {
"required": true,
"type": "long"
},
"custAddressList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniHostMacList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniHostIpList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"cos": {
"required": true,
"type": "long"
},
"evcId": {
"required": true,
"type": "long"
}
}
Example:
{
"id": "epl-1",
"numCustLocations": 2,
"custAddressList": [
"1111 MEF Dr, Honolulu HI, USA",
"2222 UNI Dr, Boston MA, MAS"
],
"uniHostMacList": [
"00:B0:95:9d:68:16",
"00:A0:C9:14:C8:29"
]
"uniHostIpList": [
"192.168.1.10",
"192.168.1.11"s
],
"cos": "gold",
"evcId": "evc-1",
}
HTTP status code 200
JSON representing modified EPL instance
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"numCustLocations": {
"required": true,
"type": "long"
},
"custAddressList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniHostMacList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniHostIpList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"cos": {
"required": true,
"type": "long"
},
"evcId": {
"required": true,
"type": "long"
}
}
Example:
{
"id": "epl-1",
"numCustLocations": 2,
"custAddressList": [
"1111 MEF Dr, Honolulu HI, USA",
"2222 UNI Dr, Boston MA, MAS"
],
"uniHostMacList": [
"00:B0:95:9d:68:16",
"00:A0:C9:14:C8:29"
]
"uniHostIpList": [
"192.168.1.10",
"192.168.1.11"s
],
"cos": "gold",
"evcId": "evc-1",
}
get /svcmgr/webapi/svc/epl/{eplid}
Query an existing EPL instance
URI Parameters
- eplid: required (string)
HTTP status code 200
JSON representing the queried EPL instance
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"numCustLocations": {
"required": true,
"type": "long"
},
"custAddressList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniHostMacList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniHostIpList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"cos": {
"required": true,
"type": "long"
},
"evcId": {
"required": true,
"type": "long"
}
}
Example:
{
"id": "epl-1",
"numCustLocations": 2,
"custAddressList": [
"1111 MEF Dr, Honolulu HI, USA",
"2222 UNI Dr, Boston MA, MAS"
],
"uniHostMacList": [
"00:B0:95:9d:68:16",
"00:A0:C9:14:C8:29"
]
"uniHostIpList": [
"192.168.1.10",
"192.168.1.11"s
],
"cos": "gold",
"evcId": "evc-1",
}
delete /svcmgr/webapi/svc/epl/{eplid}
delete an existing EPL instance
URI Parameters
- eplid: required (string)
HTTP status code 200
JSON representing deleted EPL instance
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"numCustLocations": {
"required": true,
"type": "long"
},
"custAddressList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniHostMacList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniHostIpList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"cos": {
"required": true,
"type": "long"
},
"evcId": {
"required": true,
"type": "long"
}
}
Example:
{
"id": "epl-1",
"numCustLocations": 2,
"custAddressList": [
"1111 MEF Dr, Honolulu HI, USA",
"2222 UNI Dr, Boston MA, MAS"
],
"uniHostMacList": [
"00:B0:95:9d:68:16",
"00:A0:C9:14:C8:29"
]
"uniHostIpList": [
"192.168.1.10",
"192.168.1.11"s
],
"cos": "gold",
"evcId": "evc-1",
}
Get a list of all EPL instances
get
Query a list of all existing EPL instances
get /svcmgr/webapi/svc/epl/list
Query a list of all existing EPL instances
CRUD MEF EVC Instances
CRUD MEF EVC Instances
post
Create an new EVC instance
post /evcmgr/webapi
Create an new EVC instance
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"evcType": {
"required": true,
"type": "string",
"enum" : [
"POINT_TO_POINT",
"MULTIPOINT_TO_MULTIPOINT",
"ROOTED_MULTIPOINT"
]
},
"maxUnis": {
"required": true,
"type": "long"
},
"unicastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"multicastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"broadcastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"uniIdList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniIpList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniMacList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"ceVLanIdPreservation": {
"required": true,
"type": "boolean"
},
"ceVlanCosPreservation": {
"required": true,
"type": "boolean"
},
"cosId": {
"required": true,
"type": "string"
},
"evcMaxSvcFrameSize": {
"required": true,
"type": "long"
},
"oneWayAvailability": {
"required": true,
"type": "double"
},
"oneWayFrameDelay": {
"required": true,
"type": "double"
},
"oneWayFrameLossRatio": {
"required": true,
"type": "double"
}
}
Example:
{
"id": "evc-1",
"evcType": "POINT_TO_POINT",
"maxUnis": 2,
"unicastFrameDelivery": "UNCONDITIONAL"
"multicastFrameDelivery": "UNCONDITIONAL",
"broadcastFrameDelivery": "UNCONDITIONAL",
"uniIdList": [
"UNI-1",
"UNI-2"
],
"uniIpList": [
"192.168.1.1",
"192.168.1.2"
],
"uniMacList": [
"11:00:11:11:11:11",
"11:00:22:22:22:22"
],
"ceVLanIdPreservation": true,
"ceVlanCosPreservation": true,
"cosId": "gold",
"evcMaxSvcFrameSize": 1600,
"oneWayAvailability": .99,
"oneWayFrameDelay": .32,
"oneWayFrameLossRatio": .01
}
HTTP status code 200
JSON representing created EVC instance
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"evcType": {
"required": true,
"type": "string",
"enum" : [
"POINT_TO_POINT",
"MULTIPOINT_TO_MULTIPOINT",
"ROOTED_MULTIPOINT"
]
},
"maxUnis": {
"required": true,
"type": "long"
},
"unicastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"multicastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"broadcastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"uniIdList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniIpList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniMacList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"ceVLanIdPreservation": {
"required": true,
"type": "boolean"
},
"ceVlanCosPreservation": {
"required": true,
"type": "boolean"
},
"cosId": {
"required": true,
"type": "string"
},
"evcMaxSvcFrameSize": {
"required": true,
"type": "long"
},
"oneWayAvailability": {
"required": true,
"type": "double"
},
"oneWayFrameDelay": {
"required": true,
"type": "double"
},
"oneWayFrameLossRatio": {
"required": true,
"type": "double"
}
}
Example:
{
"id": "evc-1",
"evcType": "POINT_TO_POINT",
"maxUnis": 2,
"unicastFrameDelivery": "UNCONDITIONAL"
"multicastFrameDelivery": "UNCONDITIONAL",
"broadcastFrameDelivery": "UNCONDITIONAL",
"uniIdList": [
"UNI-1",
"UNI-2"
],
"uniIpList": [
"192.168.1.1",
"192.168.1.2"
],
"uniMacList": [
"11:00:11:11:11:11",
"11:00:22:22:22:22"
],
"ceVLanIdPreservation": true,
"ceVlanCosPreservation": true,
"cosId": "gold",
"evcMaxSvcFrameSize": 1600,
"oneWayAvailability": .99,
"oneWayFrameDelay": .32,
"oneWayFrameLossRatio": .01
}
put
Modify an existing EVC instance
get
Query an existing EVC instance
delete
delete an existing EPL instance
put /evcmgr/webapi/{evcid}
Modify an existing EVC instance
URI Parameters
- evcid: required (string)
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"evcType": {
"required": true,
"type": "string",
"enum" : [
"POINT_TO_POINT",
"MULTIPOINT_TO_MULTIPOINT",
"ROOTED_MULTIPOINT"
]
},
"maxUnis": {
"required": true,
"type": "long"
},
"unicastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"multicastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"broadcastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"uniIdList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniIpList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniMacList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"ceVLanIdPreservation": {
"required": true,
"type": "boolean"
},
"ceVlanCosPreservation": {
"required": true,
"type": "boolean"
},
"cosId": {
"required": true,
"type": "string"
},
"evcMaxSvcFrameSize": {
"required": true,
"type": "long"
},
"oneWayAvailability": {
"required": true,
"type": "double"
},
"oneWayFrameDelay": {
"required": true,
"type": "double"
},
"oneWayFrameLossRatio": {
"required": true,
"type": "double"
}
}
Example:
{
"id": "evc-1",
"evcType": "POINT_TO_POINT",
"maxUnis": 2,
"unicastFrameDelivery": "UNCONDITIONAL"
"multicastFrameDelivery": "UNCONDITIONAL",
"broadcastFrameDelivery": "UNCONDITIONAL",
"uniIdList": [
"UNI-1",
"UNI-2"
],
"uniIpList": [
"192.168.1.1",
"192.168.1.2"
],
"uniMacList": [
"11:00:11:11:11:11",
"11:00:22:22:22:22"
],
"ceVLanIdPreservation": true,
"ceVlanCosPreservation": true,
"cosId": "gold",
"evcMaxSvcFrameSize": 1600,
"oneWayAvailability": .99,
"oneWayFrameDelay": .32,
"oneWayFrameLossRatio": .01
}
HTTP status code 200
JSON representing modified EVC instance
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"evcType": {
"required": true,
"type": "string",
"enum" : [
"POINT_TO_POINT",
"MULTIPOINT_TO_MULTIPOINT",
"ROOTED_MULTIPOINT"
]
},
"maxUnis": {
"required": true,
"type": "long"
},
"unicastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"multicastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"broadcastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"uniIdList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniIpList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniMacList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"ceVLanIdPreservation": {
"required": true,
"type": "boolean"
},
"ceVlanCosPreservation": {
"required": true,
"type": "boolean"
},
"cosId": {
"required": true,
"type": "string"
},
"evcMaxSvcFrameSize": {
"required": true,
"type": "long"
},
"oneWayAvailability": {
"required": true,
"type": "double"
},
"oneWayFrameDelay": {
"required": true,
"type": "double"
},
"oneWayFrameLossRatio": {
"required": true,
"type": "double"
}
}
Example:
{
"id": "evc-1",
"evcType": "POINT_TO_POINT",
"maxUnis": 2,
"unicastFrameDelivery": "UNCONDITIONAL"
"multicastFrameDelivery": "UNCONDITIONAL",
"broadcastFrameDelivery": "UNCONDITIONAL",
"uniIdList": [
"UNI-1",
"UNI-2"
],
"uniIpList": [
"192.168.1.1",
"192.168.1.2"
],
"uniMacList": [
"11:00:11:11:11:11",
"11:00:22:22:22:22"
],
"ceVLanIdPreservation": true,
"ceVlanCosPreservation": true,
"cosId": "gold",
"evcMaxSvcFrameSize": 1600,
"oneWayAvailability": .99,
"oneWayFrameDelay": .32,
"oneWayFrameLossRatio": .01
}
get /evcmgr/webapi/{evcid}
Query an existing EVC instance
URI Parameters
- evcid: required (string)
HTTP status code 200
JSON representing the queried EPL instance
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"evcType": {
"required": true,
"type": "string",
"enum" : [
"POINT_TO_POINT",
"MULTIPOINT_TO_MULTIPOINT",
"ROOTED_MULTIPOINT"
]
},
"maxUnis": {
"required": true,
"type": "long"
},
"unicastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"multicastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"broadcastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"uniIdList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniIpList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniMacList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"ceVLanIdPreservation": {
"required": true,
"type": "boolean"
},
"ceVlanCosPreservation": {
"required": true,
"type": "boolean"
},
"cosId": {
"required": true,
"type": "string"
},
"evcMaxSvcFrameSize": {
"required": true,
"type": "long"
},
"oneWayAvailability": {
"required": true,
"type": "double"
},
"oneWayFrameDelay": {
"required": true,
"type": "double"
},
"oneWayFrameLossRatio": {
"required": true,
"type": "double"
}
}
Example:
{
"id": "evc-1",
"evcType": "POINT_TO_POINT",
"maxUnis": 2,
"unicastFrameDelivery": "UNCONDITIONAL"
"multicastFrameDelivery": "UNCONDITIONAL",
"broadcastFrameDelivery": "UNCONDITIONAL",
"uniIdList": [
"UNI-1",
"UNI-2"
],
"uniIpList": [
"192.168.1.1",
"192.168.1.2"
],
"uniMacList": [
"11:00:11:11:11:11",
"11:00:22:22:22:22"
],
"ceVLanIdPreservation": true,
"ceVlanCosPreservation": true,
"cosId": "gold",
"evcMaxSvcFrameSize": 1600,
"oneWayAvailability": .99,
"oneWayFrameDelay": .32,
"oneWayFrameLossRatio": .01
}
delete /evcmgr/webapi/{evcid}
delete an existing EPL instance
URI Parameters
- evcid: required (string)
HTTP status code 200
JSON representing deleted EVC instance
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"evcType": {
"required": true,
"type": "string",
"enum" : [
"POINT_TO_POINT",
"MULTIPOINT_TO_MULTIPOINT",
"ROOTED_MULTIPOINT"
]
},
"maxUnis": {
"required": true,
"type": "long"
},
"unicastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"multicastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"broadcastFrameDelivery": {
"required": true,
"type": "string",
"enum" : [
"DISCARD",
"UNCONDITIONAL",
"CONDITIONAL"
]
},
"uniIdList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniIpList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"uniMacList": {
"required": true,
"type": "array",
"items": { "type" : "string" },
"uniqueItems": true
},
"ceVLanIdPreservation": {
"required": true,
"type": "boolean"
},
"ceVlanCosPreservation": {
"required": true,
"type": "boolean"
},
"cosId": {
"required": true,
"type": "string"
},
"evcMaxSvcFrameSize": {
"required": true,
"type": "long"
},
"oneWayAvailability": {
"required": true,
"type": "double"
},
"oneWayFrameDelay": {
"required": true,
"type": "double"
},
"oneWayFrameLossRatio": {
"required": true,
"type": "double"
}
}
Example:
{
"id": "evc-1",
"evcType": "POINT_TO_POINT",
"maxUnis": 2,
"unicastFrameDelivery": "UNCONDITIONAL"
"multicastFrameDelivery": "UNCONDITIONAL",
"broadcastFrameDelivery": "UNCONDITIONAL",
"uniIdList": [
"UNI-1",
"UNI-2"
],
"uniIpList": [
"192.168.1.1",
"192.168.1.2"
],
"uniMacList": [
"11:00:11:11:11:11",
"11:00:22:22:22:22"
],
"ceVLanIdPreservation": true,
"ceVlanCosPreservation": true,
"cosId": "gold",
"evcMaxSvcFrameSize": 1600,
"oneWayAvailability": .99,
"oneWayFrameDelay": .32,
"oneWayFrameLossRatio": .01
}
Get a list of all EVC instances
get
Query a list of all existing EVC instances
get /evcmgr/webapi/list
Query a list of all existing EVC instances
CRUD MEF CoS Instances
CRUD MEF CoS Instances
post
Create an new COS instance
post /cosmgr/webapi
Create an new COS instance
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"commitedInfoRate": {
"required": true,
"type": "long"
},
"availbility": {
"required": true,
"type": "double"
},
"frameDelay": {
"required": true,
"type": "double"
},
"frameLoss": {
"required": true,
"type": "double"
},
"jitter": {
"required": true,
"type": "double"
}
}
Example:
{
"id": "gold",
"commitedInfoRate": 100,
"availbility": 0.99,
"frameDelay": 17.43,
"frameLoss": 0.01,
"jitter": 2.43
}
HTTP status code 200
JSON representing created COS instance
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"commitedInfoRate": {
"required": true,
"type": "long"
},
"availbility": {
"required": true,
"type": "double"
},
"frameDelay": {
"required": true,
"type": "double"
},
"frameLoss": {
"required": true,
"type": "double"
},
"jitter": {
"required": true,
"type": "double"
}
}
Example:
{
"id": "gold",
"commitedInfoRate": 100,
"availbility": 0.99,
"frameDelay": 17.43,
"frameLoss": 0.01,
"jitter": 2.43
}
put
Modify an existing COS instance
get
Query an existing COS instance
delete
delete an existing EPL instance
put /cosmgr/webapi/{cosid}
Modify an existing COS instance
URI Parameters
- cosid: required (string)
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"commitedInfoRate": {
"required": true,
"type": "long"
},
"availbility": {
"required": true,
"type": "double"
},
"frameDelay": {
"required": true,
"type": "double"
},
"frameLoss": {
"required": true,
"type": "double"
},
"jitter": {
"required": true,
"type": "double"
}
}
Example:
{
"id": "gold",
"commitedInfoRate": 100,
"availbility": 0.99,
"frameDelay": 17.43,
"frameLoss": 0.01,
"jitter": 2.43
}
HTTP status code 200
JSON representing modified COS instance
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"commitedInfoRate": {
"required": true,
"type": "long"
},
"availbility": {
"required": true,
"type": "double"
},
"frameDelay": {
"required": true,
"type": "double"
},
"frameLoss": {
"required": true,
"type": "double"
},
"jitter": {
"required": true,
"type": "double"
}
}
Example:
{
"id": "gold",
"commitedInfoRate": 100,
"availbility": 0.99,
"frameDelay": 17.43,
"frameLoss": 0.01,
"jitter": 2.43
}
get /cosmgr/webapi/{cosid}
Query an existing COS instance
URI Parameters
- cosid: required (string)
HTTP status code 200
JSON representing the queried EPL instance
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"commitedInfoRate": {
"required": true,
"type": "long"
},
"availbility": {
"required": true,
"type": "double"
},
"frameDelay": {
"required": true,
"type": "double"
},
"frameLoss": {
"required": true,
"type": "double"
},
"jitter": {
"required": true,
"type": "double"
}
}
Example:
{
"id": "gold",
"commitedInfoRate": 100,
"availbility": 0.99,
"frameDelay": 17.43,
"frameLoss": 0.01,
"jitter": 2.43
}
delete /cosmgr/webapi/{cosid}
delete an existing EPL instance
URI Parameters
- cosid: required (string)
HTTP status code 200
JSON representing deleted COS instance
Body
Type: application/json
Schema:
{
"id": {
"required": true,
"type": "string"
},
"commitedInfoRate": {
"required": true,
"type": "long"
},
"availbility": {
"required": true,
"type": "double"
},
"frameDelay": {
"required": true,
"type": "double"
},
"frameLoss": {
"required": true,
"type": "double"
},
"jitter": {
"required": true,
"type": "double"
}
}
Example:
{
"id": "gold",
"commitedInfoRate": 100,
"availbility": 0.99,
"frameDelay": 17.43,
"frameLoss": 0.01,
"jitter": 2.43
}
Get a list of all COS instances
get
Query a list of all existing COS instances
get /cosmgr/webapi/list
Query a list of all existing COS instances