Skip to content

Latest commit

 

History

History
168 lines (146 loc) · 7.25 KB

deliveryservices_id_servers.rst

File metadata and controls

168 lines (146 loc) · 7.25 KB
Raw

deliveryservices/{{ID}}/servers

Caution

It's often much easier to use to-api-deliveryservices-xmlid-servers instead

GET

Retrieves properties of Edge-Tier servers assigned to a Delivery Service.

Auth. Required

Yes

Roles Required

None

Permissions Required

CACHE-GROUP:READ, CDN:READ, TYPE:READ, PROFILE:READ, DELIVERY-SERVICE:READ, SERVER:READ

Response Type

Array

Request Structure

Request Path Parameters
Name Description
ID The integral, unique identifier of the Delivery service for which servers will be displayed

Response Structure

cachegroup

A string that is the name of the Cache Group <cache-group-name> to which the server belongs

cachegroupId

An integer that is the ID of the Cache Group <cache-group-id> to which the server belongs

cdnId

An integral, unique identifier the CDN to which the server belongs

cdnName

The name of the CDN to which the server belongs

domainName

The domain name part of the FQDN (Fully Qualified Domain Name) of the server

guid

Optionally represents an identifier used to uniquely identify the server

hostName

The (short) hostname of the server

httpsPort

The port on which the server listens for incoming HTTPS requests - 443 in most cases

id

An integral, unique identifier for the server

iloIpAddress

The IPv4 address of the lights-out-management port1

iloIpGateway

The IPv4 gateway address of the lights-out-management port2

iloIpNetmask

The IPv4 subnet mask of the lights-out-management port3

iloPassword

The password of the of the lights-out-management user - displays as ****** unless the requesting user has the 'admin' role)4

iloUsername

The user name for lights-out-management5

interfaces

An array of interface and IP address information

max_bandwidth

The maximum allowed bandwidth for this interface to be considered "healthy" by Traffic Monitor. This has no effect if monitor is not true. Values are in kb/s. The value null means "no limit".

monitor

A boolean indicating if Traffic Monitor should monitor this interface

mtu

The MTU (Maximum Transmission Unit) to configure for interfaceName

name

The network interface name used by the server.

ipAddresses

An array of the IP address information for the interface

address

The IPv4 or IPv6 address and subnet mask of the server - applicable for the interface name

gateway

The IPv4 or IPv6 gateway address of the server - applicable for the interface name

service_address

A boolean determining if content will be routed to the IP address

lastUpdated

The time and date at which this server was last updated, in non-rfc-datetime

mgmtIpAddress

The IPv4 address of the server's management port

mgmtIpGateway

The IPv4 gateway of the server's management port

mgmtIpNetmask

The IPv4 subnet mask of the server's management port

offlineReason

A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status (will be empty if not offline)

physLocation

The name of the Physical Location at which the server resides

physLocationId

An integral, unique identifier for the Physical Location at which the server resides

profile

List of profile-name of the Profiles assigned to this server

rack

A string indicating "rack" location

routerHostName

The human-readable name of the router

routerPortName

The human-readable name of the router port

status

The Status of the server

health-proto

statusId

An integral, unique identifier for the status of the server

health-proto

tcpPort

The default port on which the main application listens for incoming TCP connections - 80 in most cases

type

The name of the type of this server

typeId

An integral, unique identifier for the type of this server

updPending

true if the server has updates pending, false otherwise

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: MaIvaO8OSjysr4bCkuXFEMf3o6mOqga1aM4IHN/tcP2aa1iXEmA5IrHB7DaqNX/2vGHLXvN+01FEAR/lRNqr1w==
X-Server-Name: traffic_ops_golang/
Date: Wed, 14 Nov 2018 21:28:23 GMT
Content-Length: 891

{ "response": [
    {
        "cachegroup": "CDN_in_a_Box_Edge",
        "cachegroupId": 7,
        "cdnId": 2,
        "cdnName": "CDN-in-a-Box",
        "domainName": "infra.ciab.test",
        "guid": null,
        "hostName": "edge",
        "httpsPort": 443,
        "id": 10,
        "iloIpAddress": "",
        "iloIpGateway": "",
        "iloIpNetmask": "",
        "iloPassword": "",
        "iloUsername": "",
        "lastUpdated": "2018-11-14 21:08:44+00",
        "mgmtIpAddress": "",
        "mgmtIpGateway": "",
        "mgmtIpNetmask": "",
        "offlineReason": "",
        "physLocation": "Apachecon North America 2018",
        "physLocationId": 1,
        "profileNames": ["ATS_EDGE_TIER_CACHE"],
        "rack": "",
        "routerHostName": "",
        "routerPortName": "",
        "status": "REPORTED",
        "statusId": 3,
        "tcpPort": 80,
        "type": "EDGE",
        "typeId": 11,
        "updPending": false,
        "interfaces": [{
            "ipAddresses": [
                {
                    "address": "172.16.239.100",
                    "gateway": "172.16.239.1",
                    "service_address": true
                },
                {
                    "address": "fc01:9400:1000:8::100",
                    "gateway": "fc01:9400:1000:8::1",
                    "service_address": true
                }
            ],
            "max_bandwidth": 0,
            "monitor": true,
            "mtu": 1500,
            "name": "eth0"
        }]
    }
]}

  1. See the Wikipedia article on Out-of-Band Management for more information.↩

  2. See the Wikipedia article on Out-of-Band Management for more information.↩

  3. See the Wikipedia article on Out-of-Band Management for more information.↩

  4. See the Wikipedia article on Out-of-Band Management for more information.↩

  5. See the Wikipedia article on Out-of-Band Management for more information.↩