List details of a service

List details of a service using the CloudLX service ID.

Request

Endpoint: /api/services/<service_id>/service
Method: GET
Headers: Accept: application/vnd.cloudlx.v1+json
Authorization: Bearer <access_token>

Response

                                
    {
        "id": 10,
        "name": "Azure test",
        "vlan": 101,
        "nni_vlan": 3600,
        "created": "2015-12-07 14:07:54",
        "expires": "2015-12-08 14:07:49",
        "bandwidth": "200Mbps",
        "paused": false,
        "expired": false,
        "type": "Microsoft Azure",
        "status": "up",
        "statistics": {
            "fe_fl": {
                "name": "FE FL",
                "lastvalue": "0 %",
                "lastvalue_raw": 0
            },
            "ne_fl": {
                "name": "NE FL",
                "lastvalue": "0 %",
                "lastvalue_raw": 0
            },
            "2_way_latency": {
                "name": "2 way latency",
                "lastvalue": "0.00 ms",
                "lastvalue_raw": 0
            },
            "jitter": {
                "name": "Jitter",
                "lastvalue": "0 us",
                "lastvalue_raw": 0
            },
            "discards": {
                "name": "Discards",
                "lastvalue": "0 Mb/s",
                "lastvalue_raw": 0
            },
            "uas": {
                "name": "UAS",
                "lastvalue": "0 s",
                "lastvalue_raw": 0
            },
            "conform": {
                "name": "Conform",
                "lastvalue": "0 Mb/s",
                "lastvalue_raw": 0
            },
            "total": {
                "name": "Total",
                "lastvalue": "0 Mb/s",
                "lastvalue_raw": 0
            }
        },
        "port": {
            "id": 219,
            "name": "LRHosting NYC Port 1",
            "index": 18,
            "switch": {
                "id": 1,
                "index": 1
            },
            "slot": {
                "id": 1,
                "index": 1
            },
            "shelf": {
                "id": 1,
                "index": 1
            }
        }
    }
                                
                            
id Description The CloudLX ID for the service
Type Integer
Example 10
name Description The friendly name given to the service
Type Text
Example Azure Test
vlan Description The C-Vlan the service is operating on
Type Integer
Example 101
nni_vlan Description The NNI VLAN being used if the service is connected to an NNI interface
Type Integer
Example 3600
created Description Timestamp of when the service was created
Type Timestamp
Example 2015-12-03 15:55:13
expires Description Timestamp of when the service is due to expire
Type Timestamp
Example 2015-12-03 15:55:13
bandwidth Description A string representing the bandwidth available on the connection
Type String
Example 200Mbps
paused Description Whether the service is currently in a paused state
Type Boolean
Example false
expired Description Whether the service has expired
Type Boolean
Example false
type Description A string representing the service type
Type String
Example Microsoft Azure
status Description The status of the service
Type String
Example up
statistics Description Current statistics for the services
Type Object
fe_fl Description Far end frame loss percentage values
Type Object
Example
                                            
    {
        "name": "FE FL",
        "lastvalue": "0 %",
        "lastvalue_raw": 0
    }
                                            
                                        
ne_fl Description Near end frame loss percentage values
Type Object
Example
                                            
    {
        "name": "NE FL",
        "lastvalue": "0 %",
        "lastvalue_raw": 0
    }
                                            
                                        
2_way_latency Description Two way latency time
Type Object
Example
                                            
    {
        "name": "2 way latency",
        "lastvalue": "0.00 ms",
        "lastvalue_raw": 0
    }
                                            
                                        
jitter Description Jitter time
Type Object
Example
                                            
    {
        "name": "Jitter",
        "lastvalue": "0 us",
        "lastvalue_raw": 0
    }
                                            
                                        
discard Description Discards value
Type Object
Example
                                            
    {
        "name": "Discards",
        "lastvalue": "0 Mb/s",
        "lastvalue_raw": 0
    }
                                            
                                        
uas Description Unavailable seconds time
Type Object
Example
                                            
    {
        "name": "UAS",
        "lastvalue": "0 s",
        "lastvalue_raw": 0
    }
                                            
                                        
conform Description Conform value
Type Object
Example
                                            
    {
        "name": "Conform",
        "lastvalue": "0 Mb/s",
        "lastvalue_raw": 0
    }
                                            
                                        
total Description Total service traffic value
Type Object
Example
                                            
    {
        "name": "Total",
        "lastvalue": "0 Mb/s",
        "lastvalue_raw": 0
    }
                                            
                                        
port Description Port object of the customer port the service is attached to
Type Object

Back to top