Skip to content

Latest commit

 

History

History
123 lines (110 loc) · 2.79 KB

fm_linkstatus.md

File metadata and controls

123 lines (110 loc) · 2.79 KB

Fault Management: Link Status API

Link Status API används för felsökning av tjänster. Det erbjuder aktuell information of kunds länk i access-switch/router.

Exempel

Anrop:

GET /api/2.3.1/accesses/STTA0001/link HTTP/1.1

Svar när länken är uppe:

HTTP/1.1 200 OK
Content-Type: application/json

{
	"link": "UP",
	"up": {
		"since": "2014-08-14T14:09:23Z",
		"mbps": 1000,
		"clients": [
			{
				"mac": "DE:AD:BE:EF:00:01",
				"ip": "10.10.1.181"
			}
		]
	}
}

Svar när länken är nere:

HTTP/1.1 200 OK
Content-Type: application/json

{
	"link": "DOWN"
}

Fältbeskrivningar

  • null eller "" är inte ett giltiga värden för något fält.
Fält Förklaring
link Anger status på länken.
Giltiga värden är "UP" och "DOWN".
up Innehåller information om länken, förutsatt att den är uppe.
Noden skall enbart finnas när link = "UP".
up / since Anger tidpunkt då porten gick up och sedan när den haft länk
Formatet är "YYYY-MM-DDThh:mm:ssZ" enligt ISO-8601.
Avslutande "Z" innebär att tiden alltid är i UTC.
up / mbps Anger länkens faktiskta länkhastighet.
Enheten är mbps, giltiga värden är: 10, 100, 1000.
up / clients Lista som innehåller de enheter som finns på porten.
up / clients / mac MAC-adress på enheten.
MAC-adressen representeras genom 6 par av hexadecimala siffror konkatenerade med kolon ':'. Den skall utelstutande vara i uppercase.
MAC-adressen är alltid exakt 17 tecken lång.
Exempel: "DE:AD:BE:EF:00:01".
up / clients / ip Tilldelad IPv4-adress på enheten.
IP-adress representeras som fyra decimala tal mellan 0 och 255 konkatenerade med punkter'.'.
Noden skall enbart finnas när enheten har en ipv4-adress.
Exempel: "10.101.1.181".