Equinix SmartView APIs | Equinix Product Documentation

DCIM Power APIs

Empower yourself with DCIM Power APIs. Use them to get current and trending information on power consumption by assets. These APIs return the power consumption info for all level values, given a customer account number, IBX and level type of ibx - cage, cabinet or circuit. Trending power data returns the kVA power draw and max allowed (%) for the given asset.

Operations

Retrieve current power consumption data

Request

This powerData endpoint returns power consumption info (power consumption data with comparison data of current [% Kva] vs yesterday, lastWeek, lastMonth, lastQuarter) for input ibx, cage, cabinet, circuit.

Security

BearerAuth

Query

accountNostringrequired

Customer Account Number

ibxstringrequired

IBX Code

levelTypestringrequired

level type allowed value [ibx|cage|cabinet|circuit]

Enum:"ibx""cage""cabinet""circuit"

levelValuestringrequired

level value - ibx code, cage unique space id, cabinet unique space id, serial number for level type ibx, cage, cabinet, circuit respectively.

Payload

// No request payload

Responses

Valid Response

Bodyapplication/json

payLoadobject

statusobject

Response

{
  "payLoad": {
    "ibx": "ABC",
    "accountNo": "ABC",
    "levelType": "ibx",
    "levelValue": "ABC",
    "isAlarm": "true",
    "kva": 54.402,
    "amps": 123,
    "soldKva": 598.349,
    "cabinetRating": 341.54,
    "contractualKva": 341.54,
    "percentageKva": 341.54,
    "comparisonData": { … },
    "peakKvaLastSevenDays": 55.296,
    "peakKvaLastSevenDaysPercentage": 55.296,
    "peakKvaLastSevenDaysContractualKva": 55.296,
    "peakKvaLastSevenDaysTime": 55,
    "soldAmps": 123,
    "primaryKva": 28.31,
    "redundantKva": 26.092,
    "kw": "NA",
    "powerFactor": "NA",
    "readingTime": "1497410400000",
    "lastUpdatedTime": "1497410520000",
    "customerName": "ABC"
  },
  "status": {
    "type": "INFO",
    "statuscode": 1000,
    "msg": "OK"
  }
}