Skip to content
Aerospike Cloud/Reference/Cloud API/cluster/getClusterMetrics

Get cluster metrics

GET
/database/clusters/{clusterId}/metrics

Returns all metrics for the given cluster

Authorizations

Parameters

Path Parameters

clusterId
required
string
format: uuid

A cluster ID.

Responses

200

A cluster 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

RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses.

object
type
required

URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN.

string
Allowed values:
urn:aerospike:errors:auth:unauthorized
urn:aerospike:errors:auth:token-expired
urn:aerospike:errors:resource:not-found
urn:aerospike:errors:resource:already-exists
urn:aerospike:errors:validation:failed
urn:aerospike:errors:system:internal
urn:aerospike:errors:system:unavailable
urn:aerospike:errors:ratelimit:exceeded
title
required

A short, human-readable summary of the problem type

string
Example:
Resource Not Found
status
required

The HTTP status code

integer
Example:
404
detail

A human-readable explanation specific to this occurrence

string
Example:
The requested cluster could not be found.
instance

A URI reference that identifies the specific occurrence

string
format: uri
context
Any of:

Context for resource-related errors (not-found, already-exists)

object
resource

Type of resource (e.g., cluster, database, organization)

string
Example:
cluster
id

Identifier of the resource

string
Example:
abc-123
message

Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.

string
Example:
The requested cluster could not be found.
Example
Example:
{ "type": "urn:aerospike:errors:validation:failed", "title": "Validation Error", "status": 400, "detail": "The provided information is not in the correct format.", "instance": "string", "context": { "invalid": [ { "field": "/name", "type": "urn:aerospike:errors:validation:too-long" }, { "field": "/region", "type": "urn:aerospike:errors:validation:too-short" } ] }, "message": "The provided information is not in the correct format." }

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

RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses.

object
type
required

URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN.

string
Allowed values:
urn:aerospike:errors:auth:unauthorized
urn:aerospike:errors:auth:token-expired
urn:aerospike:errors:resource:not-found
urn:aerospike:errors:resource:already-exists
urn:aerospike:errors:validation:failed
urn:aerospike:errors:system:internal
urn:aerospike:errors:system:unavailable
urn:aerospike:errors:ratelimit:exceeded
title
required

A short, human-readable summary of the problem type

string
Example:
Resource Not Found
status
required

The HTTP status code

integer
Example:
404
detail

A human-readable explanation specific to this occurrence

string
Example:
The requested cluster could not be found.
instance

A URI reference that identifies the specific occurrence

string
format: uri
context
Any of:

Context for resource-related errors (not-found, already-exists)

object
resource

Type of resource (e.g., cluster, database, organization)

string
Example:
cluster
id

Identifier of the resource

string
Example:
abc-123
message

Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.

string
Example:
The requested cluster could not be found.
Example
Example:
{ "type": "urn:aerospike:errors:auth:token-expired", "title": "Token Expired", "status": 401, "detail": "Your session has expired. Please log in again.", "instance": "string", "context": { "resource": "cluster", "id": "abc-123" }, "message": "Your session has expired. Please log in again." }

403

Permission denied

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

ID uniquely identifying the request/response cycle.

Response Schema

RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses.

object
type
required

URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN.

string
Allowed values:
urn:aerospike:errors:auth:unauthorized
urn:aerospike:errors:auth:token-expired
urn:aerospike:errors:resource:not-found
urn:aerospike:errors:resource:already-exists
urn:aerospike:errors:validation:failed
urn:aerospike:errors:system:internal
urn:aerospike:errors:system:unavailable
urn:aerospike:errors:ratelimit:exceeded
title
required

A short, human-readable summary of the problem type

string
Example:
Resource Not Found
status
required

The HTTP status code

integer
Example:
404
detail

A human-readable explanation specific to this occurrence

string
Example:
The requested cluster could not be found.
instance

A URI reference that identifies the specific occurrence

string
format: uri
context
Any of:

Context for resource-related errors (not-found, already-exists)

object
resource

Type of resource (e.g., cluster, database, organization)

string
Example:
cluster
id

Identifier of the resource

string
Example:
abc-123
message

Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.

string
Example:
The requested cluster could not be found.
Example
Example:
{ "type": "urn:aerospike:errors:auth:unauthorized", "title": "Unauthorized", "status": 403, "detail": "You don't have permission to access this resource.", "instance": "string", "context": { "resource": "cluster", "id": "abc-123" }, "message": "You don't have permission to access this resource." }

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

RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses.

object
type
required

URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN.

string
Allowed values:
urn:aerospike:errors:auth:unauthorized
urn:aerospike:errors:auth:token-expired
urn:aerospike:errors:resource:not-found
urn:aerospike:errors:resource:already-exists
urn:aerospike:errors:validation:failed
urn:aerospike:errors:system:internal
urn:aerospike:errors:system:unavailable
urn:aerospike:errors:ratelimit:exceeded
title
required

A short, human-readable summary of the problem type

string
Example:
Resource Not Found
status
required

The HTTP status code

integer
Example:
404
detail

A human-readable explanation specific to this occurrence

string
Example:
The requested cluster could not be found.
instance

A URI reference that identifies the specific occurrence

string
format: uri
context
Any of:

Context for resource-related errors (not-found, already-exists)

object
resource

Type of resource (e.g., cluster, database, organization)

string
Example:
cluster
id

Identifier of the resource

string
Example:
abc-123
message

Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.

string
Example:
The requested cluster could not be found.
Example
Example:
{ "type": "urn:aerospike:errors:resource:not-found", "title": "Resource Not Found", "status": 404, "detail": "The requested resource could not be found.", "instance": "string", "context": { "resource": "cluster", "id": "abc-123" }, "message": "The requested resource could not be found." }

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

RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses.

object
type
required

URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN.

string
Allowed values:
urn:aerospike:errors:auth:unauthorized
urn:aerospike:errors:auth:token-expired
urn:aerospike:errors:resource:not-found
urn:aerospike:errors:resource:already-exists
urn:aerospike:errors:validation:failed
urn:aerospike:errors:system:internal
urn:aerospike:errors:system:unavailable
urn:aerospike:errors:ratelimit:exceeded
title
required

A short, human-readable summary of the problem type

string
Example:
Resource Not Found
status
required

The HTTP status code

integer
Example:
404
detail

A human-readable explanation specific to this occurrence

string
Example:
The requested cluster could not be found.
instance

A URI reference that identifies the specific occurrence

string
format: uri
context
Any of:

Context for resource-related errors (not-found, already-exists)

object
resource

Type of resource (e.g., cluster, database, organization)

string
Example:
cluster
id

Identifier of the resource

string
Example:
abc-123
message

Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.

string
Example:
The requested cluster could not be found.
Example
Example:
{ "type": "urn:aerospike:errors:system:internal", "title": "Internal Server Error", "status": 500, "detail": "An unexpected error occurred. Please try again later.", "instance": "string", "context": { "resource": "cluster", "id": "abc-123" }, "message": "An unexpected error occurred. Please try again later." }
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?