support-ticket-analyzer / backend /docs /docs-cloud-reference-api-cluster-listclusters.txt
tomeese's picture
Claude Opus 5.5
Rebrand as Halyard Cloud ticket analyzer; add triage, replies and personas
d0954af
Raw History Blame Contribute Delete
7.63 kB
TITLE: List clusters.
URL:
============================================================
List clusters.
Retrieves a list of all clusters accessible to the user.
The list can be filtered by status.
publicOauth2 read:database
Filter clusters to exclude any matching one or more of the specified statuses.
Provide statuses as a single comma-separated list (e.g., ?status_ne=deleting,failed).
The maximum number of items to return in a single response.
Used for pagination. Must be between 1 and 100.
The number of items to skip before starting to return results.
Used for pagination. For example, to get the next 10 items after the first 10,
set offset to 10.
A collection of clusters
ID uniquely identifying the request/response cycle.
Number of items returned in the current result set.
Pagination metadata
Total number of items available
Maximum number of items per page
Number of items skipped before the current result set
Unique identifier for this resource within Halyard Cloud
Host name that clients will use to connect to the cluster. Correlates to the HALYARD_CLOUD_HOST variable in documentation and code samples.
HALYARD_CLOUD_HOST
PEM encoded TLS certificate for the cluster.
The ARN of the S3 bucket the logs reside in
A list of role ARNs authorized to read the log bucket
Cloud provider for the infrastructure
Instance type for vertical scaling
AWS region where resources will be deployed
Number of availability zones to spread resources across
AWS availability zone IDs for halyard nodes
The /19 IPv4 CIDR block for the database VPC
The network ID of the database
The account ID of the database
gp2
gp3
io1
io2
General Purpose SSD (gp2)
Size of the EBS volume in gigabytes
General Purpose SSD (gp3)
IOPS for gp3 (min 3000, max 16000). Max 500 IOPS per GB (not enforced by schema).
Size of the EBS volume in gigabytes
Provisioned IOPS SSD (io1)
IOPS for io1 (min 100, max 64000). Max 50 IOPS per GB (not enforced by schema).
Size of the EBS volume in gigabytes (min 4 for io1)
Provisioned IOPS SSD (io2)
IOPS for io2 (min 100, max 64000). Max 1000 IOPS per GB (not enforced by schema).
Size of the EBS volume in gigabytes (min 4 for io2)
The Route 53 hosted zone ID for the database
In-memory database
Local disk database
Network storage database
Number of nodes in the cluster (horizontal scaling)
Persist data using local disks or network storage. If omitted, data is stored in-memory without persistence.
Number of nodes in the cluster (horizontal scaling)
Persist data using network storage. If omitted, data is stored only on local SSDs without additional persistence.
Number of nodes in the cluster (horizontal scaling)
Halyard server configuration
object
object
string
Array<string>
string
Array<string>
object
object
string
Array<string>
string
Array<string>
object
object
object
object
object
object
object
object
object
object
object
object
The address, port and TLS name of the node. The TLS name is optional.
Access token is missing or invalid
ID uniquely identifying the request/response cycle.
RFC 9457 Problem Details for HTTP APIs.
Provides a standardized format for conveying error details in HTTP responses.
URN-based error type identifiers following the pattern:
urn:halyard:errors:{category}:{specific}
Resource information (cluster, database, organization, etc.) is provided
in the ProblemDetails context field, not in the URN.
A short, human-readable summary of the problem type
The HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
object
object
object
Context for resource-related errors (not-found, already-exists)
Type of resource (e.g., cluster, database, organization)
Identifier of the resource
Structured context for validation errors
JSON Pointer paths to missing required fields
Details about invalid field values
JSON Pointer path to the invalid field
URN identifying the specific validation error type
An optional human-readable description of the validation error
Developer-friendly message explaining the error.
Deprecated: Use ‘detail’ field instead.
Permission denied
ID uniquely identifying the request/response cycle.
RFC 9457 Problem Details for HTTP APIs.
Provides a standardized format for conveying error details in HTTP responses.
URN-based error type identifiers following the pattern:
urn:halyard:errors:{category}:{specific}
Resource information (cluster, database, organization, etc.) is provided
in the ProblemDetails context field, not in the URN.
A short, human-readable summary of the problem type
The HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
object
object
object
Context for resource-related errors (not-found, already-exists)
Type of resource (e.g., cluster, database, organization)
Identifier of the resource
Structured context for validation errors
JSON Pointer paths to missing required fields
Details about invalid field values
JSON Pointer path to the invalid field
URN identifying the specific validation error type
An optional human-readable description of the validation error
Developer-friendly message explaining the error.
Deprecated: Use ‘detail’ field instead.
Internal Server Error
ID uniquely identifying the request/response cycle.
RFC 9457 Problem Details for HTTP APIs.
Provides a standardized format for conveying error details in HTTP responses.
URN-based error type identifiers following the pattern:
urn:halyard:errors:{category}:{specific}
Resource information (cluster, database, organization, etc.) is provided
in the ProblemDetails context field, not in the URN.
A short, human-readable summary of the problem type
The HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
object
object
object
Context for resource-related errors (not-found, already-exists)
Type of resource (e.g., cluster, database, organization)
Identifier of the resource
Structured context for validation errors
JSON Pointer paths to missing required fields
Details about invalid field values
JSON Pointer path to the invalid field
URN identifying the specific validation error type
An optional human-readable description of the validation error
Developer-friendly message explaining the error.
Deprecated: Use ‘detail’ field instead.
The endpoint has not been implemented yet.
RFC 9457 Problem Details for HTTP APIs.
Provides a standardized format for conveying error details in HTTP responses.
URN-based error type identifiers following the pattern:
urn:halyard:errors:{category}:{specific}
Resource information (cluster, database, organization, etc.) is provided
in the ProblemDetails context field, not in the URN.
A short, human-readable summary of the problem type
The HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
object
object
object
Context for resource-related errors (not-found, already-exists)
Type of resource (e.g., cluster, database, organization)
Identifier of the resource
Structured context for validation errors
JSON Pointer paths to missing required fields
Details about invalid field values
JSON Pointer path to the invalid field
URN identifying the specific validation error type
An optional human-readable description of the validation error
Developer-friendly message explaining the error.
Deprecated: Use ‘detail’ field instead.