Skip to content
Inviting nominations for the Champions of Scale - Nominate a leader building internet-scale data infastructure today! Nominate someone
Aerospike Cloud/Reference/Cloud API/database/getDatabaseMetrics

Get database metrics

GET
/databases/{databaseId}/metrics

Returns all metrics for the given database

Authorizations

Parameters

Path Parameters

databaseId
required
string
format: uuid

A database ID.

Responses

200

A database metrics request response.

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema
object
uniqueData
object
now
Array<string>
Example:
[ "1678128445.119", "0.033200143" ]
dailyAvg

Range of metric vectors over a specific time period.

Array<Array<string>>
dailyMin

Range of metric vectors over a specific time period.

Array<Array<string>>
dailyMax

Range of metric vectors over a specific time period.

Array<Array<string>>
storage
object
bytesMax
integer
format: int64
memoryMax
integer
format: int64
bytesUsed
object
now
Array<string>
Example:
[ "1678128445.119", "0.033200143" ]
hourlyAvg

Range of metric vectors over a specific time period.

Array<Array<string>>
hourlyMin

Range of metric vectors over a specific time period.

Array<Array<string>>
hourlyMax

Range of metric vectors over a specific time period.

Array<Array<string>>
memoryUsed
object
now
Array<string>
Example:
[ "1678128445.119", "0.033200143" ]
hourlyAvg

Range of metric vectors over a specific time period.

Array<Array<string>>
hourlyMin

Range of metric vectors over a specific time period.

Array<Array<string>>
hourlyMax

Range of metric vectors over a specific time period.

Array<Array<string>>
objectsUsed
object
now
Array<string>
Example:
[ "1678128445.119", "0.033200143" ]
hourlyAvg

Range of metric vectors over a specific time period.

Array<Array<string>>
hourlyMin

Range of metric vectors over a specific time period.

Array<Array<string>>
hourlyMax

Range of metric vectors over a specific time period.

Array<Array<string>>
throughput
object
objectSizeAvg
object
now
Array<string>
Example:
[ "1678128445.119", "0.033200143" ]
hourlyAvg

Range of metric vectors over a specific time period.

Array<Array<string>>
dailyAvg

Range of metric vectors over a specific time period.

Array<Array<string>>
readTps
object
now
Array<string>
Example:
[ "1678128445.119", "0.033200143" ]
hourlyAvg

Range of metric vectors over a specific time period.

Array<Array<string>>
hourlyMin

Range of metric vectors over a specific time period.

Array<Array<string>>
hourlyMax

Range of metric vectors over a specific time period.

Array<Array<string>>
now
Array<string>
Example:
[ "1678128445.119", "0.033200143" ]
dailyAvg

Range of metric vectors over a specific time period.

Array<Array<string>>
dailyMin

Range of metric vectors over a specific time period.

Array<Array<string>>
dailyMax

Range of metric vectors over a specific time period.

Array<Array<string>>
writeTps
object
now
Array<string>
Example:
[ "1678128445.119", "0.033200143" ]
hourlyAvg

Range of metric vectors over a specific time period.

Array<Array<string>>
hourlyMin

Range of metric vectors over a specific time period.

Array<Array<string>>
hourlyMax

Range of metric vectors over a specific time period.

Array<Array<string>>
now
Array<string>
Example:
[ "1678128445.119", "0.033200143" ]
dailyAvg

Range of metric vectors over a specific time period.

Array<Array<string>>
dailyMin

Range of metric vectors over a specific time period.

Array<Array<string>>
dailyMax

Range of metric vectors over a specific time period.

Array<Array<string>>
readTpsSuccess
object
hourlyAvg

Range of metric vectors over a specific time period.

Array<Array<string>>
writeTpsSuccess
object
hourlyAvg

Range of metric vectors over a specific time period.

Array<Array<string>>
batchReadTpsSuccess
object
hourlyAvg

Range of metric vectors over a specific time period.

Array<Array<string>>
batchWriteTpsSuccess
object
hourlyAvg

Range of metric vectors over a specific time period.

Array<Array<string>>
queryTpsSuccess
object
hourlyAvg

Range of metric vectors over a specific time period.

Array<Array<string>>
latency
object
read
object
quantile95
object
minutely

Range of metric vectors over a specific time period.

Array<Array<string>>
quantile99
object
minutely

Range of metric vectors over a specific time period.

Array<Array<string>>
quantile999
object
minutely

Range of metric vectors over a specific time period.

Array<Array<string>>
write
object
quantile95
object
minutely

Range of metric vectors over a specific time period.

Array<Array<string>>
quantile99
object
minutely

Range of metric vectors over a specific time period.

Array<Array<string>>
quantile999
object
minutely

Range of metric vectors over a specific time period.

Array<Array<string>>
transactions
object
readCount
object
daily

Range of metric vectors over a specific time period.

Array<Array<string>>
writeCount
object
daily

Range of metric vectors over a specific time period.

Array<Array<string>>
errors
object
keyBusy
object
hourly

Range of metric vectors over a specific time period.

Array<Array<string>>
generationFail
object
hourly

Range of metric vectors over a specific time period.

Array<Array<string>>
timeout
object
hourly

Range of metric vectors over a specific time period.

Array<Array<string>>
recordSize
object
hourly

Range of metric vectors over a specific time period.

Array<Array<string>>
Example
Content type: application/json
{ 
{
"uniqueData": { 
"now": [ 
"string"
],
"dailyAvg": [ 
[ 
"string"
]
],
"dailyMin": [ 
[ 
"string"
]
],
"dailyMax": [ 
[ 
"string"
]
]
},
"storage": { 
"bytesMax": "integer",
"memoryMax": "integer",
"bytesUsed": { 
"now": [ 
"string"
],
"hourlyAvg": [ 
[ 
"string"
]
],
"hourlyMin": [ 
[ 
"string"
]
],
"hourlyMax": [ 
[ 
"string"
]
]
},
"memoryUsed": { 
"now": [ 
"string"
],
"hourlyAvg": [ 
[ 
"string"
]
],
"hourlyMin": [ 
[ 
"string"
]
],
"hourlyMax": [ 
[ 
"string"
]
]
},
"objectsUsed": { 
"now": [ 
"string"
],
"hourlyAvg": [ 
[ 
"string"
]
],
"hourlyMin": [ 
[ 
"string"
]
],
"hourlyMax": [ 
[ 
"string"
]
]
}
},
"throughput": { 
"objectSizeAvg": { 
"now": [ 
"string"
],
"hourlyAvg": [ 
[ 
"string"
]
],
"dailyAvg": [ 
[ 
"string"
]
]
},
"readTps": { 
"now": [ 
"string"
],
"hourlyAvg": [ 
[ 
"string"
]
],
"hourlyMin": [ 
[ 
"string"
]
],
"hourlyMax": [ 
[ 
"string"
]
],
"dailyAvg": [ 
[ 
"string"
]
],
"dailyMin": [ 
[ 
"string"
]
],
"dailyMax": [ 
[ 
"string"
]
]
},
"writeTps": { 
"now": [ 
"string"
],
"hourlyAvg": [ 
[ 
"string"
]
],
"hourlyMin": [ 
[ 
"string"
]
],
"hourlyMax": [ 
[ 
"string"
]
],
"dailyAvg": [ 
[ 
"string"
]
],
"dailyMin": [ 
[ 
"string"
]
],
"dailyMax": [ 
[ 
"string"
]
]
},
"readTpsSuccess": { 
"hourlyAvg": [ 
[ 
"string"
]
]
},
"writeTpsSuccess": { 
"hourlyAvg": [ 
[ 
"string"
]
]
},
"batchReadTpsSuccess": { 
"hourlyAvg": [ 
[ 
"string"
]
]
},
"batchWriteTpsSuccess": { 
"hourlyAvg": [ 
[ 
"string"
]
]
},
"queryTpsSuccess": { 
"hourlyAvg": [ 
[ 
"string"
]
]
}
},
"latency": { 
"read": { 
"quantile95": { 
"minutely": [ 
[ 
"string"
]
]
},
"quantile99": { 
"minutely": [ 
[ 
"string"
]
]
},
"quantile999": { 
"minutely": [ 
[ 
"string"
]
]
}
},
"write": { 
"quantile95": { 
"minutely": [ 
[ 
"string"
]
]
},
"quantile99": { 
"minutely": [ 
[ 
"string"
]
]
},
"quantile999": { 
"minutely": [ 
[ 
"string"
]
]
}
}
},
"transactions": { 
"readCount": { 
"daily": [ 
[ 
"string"
]
]
},
"writeCount": { 
"daily": [ 
[ 
"string"
]
]
},
"errors": { 
"keyBusy": { 
"hourly": [ 
[ 
"string"
]
]
},
"generationFail": { 
"hourly": [ 
[ 
"string"
]
]
},
"timeout": { 
"hourly": [ 
[ 
"string"
]
]
},
"recordSize": { 
"hourly": [ 
[ 
"string"
]
]
}
}
}
}

400

Invalid input

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object
code

Unique (system-wide) error code for an error happened

string
message
required

Developer-friendly message explaining error

string
key
additional properties
any
Example
Content type: application/json
{ 
{
"code": "string",
"message": "string"
}

401

Access token is missing or invalid

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object
code

Unique (system-wide) error code for an error happened

string
message
required

Developer-friendly message explaining error

string
key
additional properties
any
Example
Content type: application/json
{ 
{
"code": "invalid_token",
"message": "The access token expired."
}

403

Permission denied

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object
code

Unique (system-wide) error code for an error happened

string
message
required

Developer-friendly message explaining error

string
key
additional properties
any
Example
Content type: application/json
{ 
{
"code": "string",
"message": "string"
}

404

Resource not found

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object
code

Unique (system-wide) error code for an error happened

string
message
required

Developer-friendly message explaining error

string
key
additional properties
any
Example
Content type: application/json
{ 
{
"code": "string",
"message": "string"
}

500

Internal Server Error

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object
code

Unique (system-wide) error code for an error happened

string
message
required

Developer-friendly message explaining error

string
key
additional properties
any
Example
Content type: application/json
{ 
{
"code": "string",
"message": "string"
}
Feedback

Was this page helpful?

What type of feedback are you giving?

What would you like us to know?

+Capture screenshot

Can we reach out to you?