DCIM Power APIs (1.0)

Download OpenAPI specification:Download

URL: https://docs.equinix.com/api-support.htm Terms of Service

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.

DCIM Power

Access Power Consumption Information

Fetch current power consumption data

The 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.

query Parameters

accountNo required	string Customer Account Number
ibx required	string IBX Code
levelType required	string Enum: "ibx" "cage" "cabinet" "circuit" level type allowed value [ibx\|cage\|cabinet\|circuit]
levelValue required	string level value - ibx code, cage unique space id, cabinet unique space id, serial number for level type ibx, cage, cabinet, circuit respectively.

header Parameters

Authorization

required

string

Specify the OAuth Bearer token with prefix 'Bearer '.

Responses

Response Schema: application/json

object

ibx

string

ibx code

accountNo

string

customer account number

levelType

string

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

power hierarchy node levelType linked to the power data

levelValue

string

power hierarchy node levelValue linked to the power data

isAlarm

string

returns boolean based on breakertip alarm

kva

number

power consumption in kva

amps

number

instantaneous current amp reading on circuits

soldKva

number

maximum amp draw allowable on a circuit

cabinetRating

number

maximum kVA draw allowed for the cabinet|cabinet description when the levelType is cabinet. Null otherwise.

contractualKva

number

The maximum power draw contractually allowable in a private cage.

percentageKva

number

calculated field kva / contractualKva

object (ComparisonData)

comparison of readings with the current reading for specified datapoint

datapoint	string Value: "percentageKva" datapoint on which the comparison is done.
yesterday	number comparison for the current value of the datapoint with yesterday's value
lastWeek	number comparison for the current value of the datapoint with last week's value
lastMonth	number comparison for the current value of the datapoint with the last month's value
lastQuarter	number comparison for the current value of the datapoint with the last quarter's value

peakKvaLastSevenDays

number

peakKvaLastSevenDaysPercentage

number

peakKvaLastSevenDaysContractualKva

number

peakKvaLastSevenDaysTime

integer

soldAmps

integer

circuit description when the levelType is circuit. Null otherwise.

primaryKva

number

the sum of instantaneous power draw reading on all the primary circuits within the levelType.

redundantKva

number

the sum of instantaneous power draw reading on all the redundant circuits within the levelType.

string

measure of real power expressed in kilowatt applicable for ibxs that have capability of energy meter reading|value will be "NA" for AMER and APAC regions

powerFactor

string

The ratio between real power and apparent power in a circuit.(kW/kVA)|value will be "NA" for AMER and APAC regions

readingTime

string

date-time when the latest value was read in (epoc - milliseconds).

lastUpdatedTime

string

date-time when the latest value was updated (epoc - milliseconds).

customerName

string

object

type	string Value: "INFO" [INFO\|ERROR] are the possible values
statuscode	number [1000\|3001\|3002\|3003\|4000] are the possible status codes
msg	string [Ok\|Permission Denied\|Invalid Account number\|Invalid IBX\|Invalid LevelType\|Invalid LevelValue\|Invalid Interval\|Invalid From/To Date\|INVALID_SESSION\|INVALID_SESSION_IBX\|INTERNAL_ERROR] are the possible messages

Response samples

200
default

Content type

application/json

{"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": {"datapoint": "percentageKva",
"yesterday": 0.147,
"lastWeek": -0.295,
"lastMonth": -0.184,
"lastQuarter": 52.434
},
"peakKvaLastSevenDays": 55.296,
"peakKvaLastSevenDaysPercentage": 55.296,
"peakKvaLastSevenDaysContractualKva": 55.296,
"peakKvaLastSevenDaysTime": 55.296,
"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"
}
}

Fetch current power consumption data

The powerdata endpoint returns power consumption info for all values of input level type ibx, cage, cabinet or circuit.

header Parameters

Authorization

required

string

Specify the OAuth Bearer token with prefix 'Bearer '.

Request Body schema: application/json

request payload

accountNo	string Customer Account Number
ibx	string trending values
levelType	string Enum: "ibx" "cage" "cabinet" "circuit" level type allowed value [ibx\|cage\|cabinet\|circuit]

Responses

Response Schema: application/json

object

Array of objects (PowerData_IBX)

Array

ibx	string ibx code
accountNo	string customer account number
levelType	string Enum: "ibx" "cage" "cabinet" "circuit" power hierarchy node levelType linked to the power data
levelValue	string power hierarchy node levelValue linked to the power data
isAlarm	string returns boolean based on breakertip alarm
kva	number power consumption in kva
amps	number instantaneous current amp reading on circuits
soldKva	number maximum amp draw allowable on a circuit
cabinetRating	number maximum kVA draw allowed for the cabinet
contractualKva	number The maximum power draw contractually allowable in a private cage. example: 341.54
percentageKva	number calculated field kva / contractualKva
	object (ComparisonData) comparison of readings with the current reading for specified datapoint
peakKvaLastSevenDays	number
peakKvaLastSevenDaysPercentage	number
peakKvaLastSevenDaysContractualKva	number
peakKvaLastSevenDaysTime	integer
soldAmps	integer circuit description when the levelType is circuit. Null otherwise.
primaryKva	number the sum of instantaneous power draw reading on all the primary circuits within the levelType.
redundantKva	number the sum of instantaneous power draw reading on all the redundant circuits within the levelType.
kw	string measure of real power expressed in kilowatt applicable for ibxs that have capability of energy meter reading\|value will be "NA" for AMER and APAC regions
powerFactor	string The ratio between real power and apparent power in a circuit.(kW/kVA)\|value will be "NA" for AMER and APAC regions
readingTime	string date-time when the latest value was read in (epoc - milliseconds).
lastUpdatedTime	string date-time when the latest value was updated (epoc - milliseconds).
customerName	string

object

type	string Value: "INFO" [INFO\|ERROR] are the possible values
statuscode	number [1000\|3001\|3002\|3003\|4000] are the possible status codes
msg	string [Ok\|Permission Denied\|Invalid Account number\|Invalid IBX\|Invalid LevelType\|Invalid LevelValue\|Invalid Interval\|Invalid From/To Date\|INVALID_SESSION\|INVALID_SESSION_IBX\|INTERNAL_ERROR] are the possible messages

Request samples

Payload

Content type

application/json

{"accountNo": "1234",
"ibx": "0.147",
"levelType": "0.147"
}

Response samples

200
default

Content type

application/json

{"payLoad": {"data": [{"ibx": "ABC",
"accountNo": "ABC",
"levelType": "ibx",
"levelValue": "ABC",
"isAlarm": "true",
"kva": 54.402,
"amps": 123,
"soldKva": 598.349,
"cabinetRating": 123,
"contractualKva": 0,
"percentageKva": 15.928,
"comparisonData": {"datapoint": "percentageKva",
"yesterday": 0.147,
"lastWeek": -0.295,
"lastMonth": -0.184,
"lastQuarter": 52.434
},
"peakKvaLastSevenDays": 55.296,
"peakKvaLastSevenDaysPercentage": 55.296,
"peakKvaLastSevenDaysContractualKva": 55.296,
"peakKvaLastSevenDaysTime": 55.296,
"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"
}
}

Fetch Trending Power Data.

The trending power data for draw kVA to max allowed (%) for input ibx, cage, cabinet, circuit.

query Parameters

accountNo required	string Customer Account Number
ibx required	number IBX Code
levelType required	string Enum: "ibx" "cage" "cabinet" "circuit" [ibx\|cage\|cabinet\|circuit]
levelValue required	string ibx code, cage unique space id, cabinet unique space id and serial number for level type ibx, cage, cabinet and circuit respectively.
interval required	string [recording\|1h\|1d]
fromDate required	string timestamp expected to be epoch long ( milliseconds ).
toDate required	string timestamp expected to be epoch long ( milliseconds ).

header Parameters

Authorization

required

string

Specify the OAuth Bearer token with prefix 'Bearer '.

Responses

Response Schema: application/json

object

accountNumber

string

ibx

string

levelType

string

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

power hierarchy node levelType linked to the power data

levelValue

string

ibx code, cage unique space id, cabinet unique space id and serial number for levelType ibx, cage, cabinet, circuit resp.

interval

string

Enum: "5m" "15m" "1h" "1d"

serial number

Array of objects (ComparisonData_Trend)

Array

datetime	string datetime.
value	string trending values

object

type	string Value: "INFO" [INFO\|ERROR] are the possible values
statuscode	number [1000\|3001\|3002\|3003\|4000] are the possible status codes
msg	string [Ok\|Permission Denied\|Invalid Account number\|Invalid IBX\|Invalid LevelType\|Invalid LevelValue\|Invalid Interval\|Invalid From/To Date\|From/ToDate interval cannot be greater than 1 year\|INVALID_SESSION\|INVALID_SESSION_IBX\|INTERNAL_ERROR] are the possible messages

Response samples

200
default

Content type

application/json

{"payLoad": {"accountNumber": "123456",
"ibx": "ABX",
"levelType": "ibx",
"levelValue": "ABX",
"interval": "1h",
"data": [{"datetime": "201701010004",
"value": "0.147"
}
]
},
"status": {"type": "INFO",
"statuscode": "1000",
"msg": "OK"
}
}