List backups and restores for each node in a given cluster, for the last 7 days.
{- "clusterDataCentres": [
- {
- "id": "a8c32b20-c8f0-11e7-abc4-cec278b6b50a",
- "name": "AWS_VPC_US_EAST_1",
- "nodes": [
- {
- "events": [
- {
- "end": 1510585212265,
- "progress": 0.5,
- "start": 1510585212265,
- "state": "ACTIVE",
- "type": "snapshot-upload"
}
], - "id": "cb986e08-f6be-4d08-8de2-4352c2cfaf1f",
- "privateAddress": "10.0.0.1",
- "publicAddress": "50.0.0.1"
}
]
}
], - "id": "77b5a4e1-c422-4a78-b551-d8fa5c42ad95",
- "name": "example-cluster"
}
Successfully retrieved compatible node sizes for Valkey.
[- {
- "cloudProviderNodeSizes": [
- {
- "nodeSizes": [
- "m5xl-400-v2",
- "r5xl-2000-v2"
], - "cloudProvider": "AWS_VPC",
- "document": "string"
}
]
}
]
Successfully retrieved versions of Valkey.
[- {
- "applicationVersions": [
- {
- "application": "[APPLICATION]",
- "versions": [
- "1.0.0",
- "1.0.1"
]
}
]
}
]
Valkey cluster certificates are returned as a .zip file. The file contains an X.509 cluster Certificate Authority certificate in JKS file, an X.509 cluster Certificate Authority certificate in PEM-encoded (ASCII) format, and an X.509 cluster Certificate Authority certificate in DER-encoded (binary) format.
Successfully create the Valkey cluster's certificate
Valkey Cluster Restore requested
{- "cdcConfigs": [
- {
- "cdcId": "a8c32b20-c8f0-11e7-abc4-cec278b6b50a",
- "customVpcSettings": {
- "network": "10.0.0.0/16",
- "vpcId": "vpc-002512aa"
}, - "restoreMode": "CUSTOM_VPC"
}
], - "clusterId": "c0e5e2ff-affe-444c-bdca-707c7b48aaad",
- "pointInTime": 1420070400000,
- "restoredClusterId": "b8a32a20-d8e0-11a7-def4-sdc278a6a50b",
- "restoredClusterName": "my-restored-cluster"
}
{- "cdcConfigs": [
- {
- "cdcId": "a8c32b20-c8f0-11e7-abc4-cec278b6b50a",
- "customVpcSettings": {
- "network": "10.0.0.0/16",
- "vpcId": "vpc-002512aa"
}, - "restoreMode": "CUSTOM_VPC"
}
], - "clusterId": "c0e5e2ff-affe-444c-bdca-707c7b48aaad",
- "pointInTime": 1420070400000,
- "restoredClusterId": "b8a32a20-d8e0-11a7-def4-sdc278a6a50b",
- "restoredClusterName": "my-restored-cluster"
}
clientToNodeEncryption required | boolean Enables Client ⇄ Node Encryption. |
pciComplianceMode required | boolean Creates a PCI compliant cluster, see PCI Compliance. |
valkeyVersion required | string[0-9]+\.[0-9]+\.[0-9]+ Version of Valkey to run on the cluster. Available versions:
|
description | string A description of the cluster |
Array of objects (TwoFactorDeleteSettingsV2) <= 1 items | |
required | Array of objects (ValkeyDataCentreV2) [ 1 .. 2 ] items List of data centre settings. |
currentClusterOperationStatus | string (CurrentClusterOperationStatusV2) Indicates if the cluster is currently performing any restructuring operation such as being created or resized |
privateNetworkCluster required | boolean Creates the cluster with private network only, see Private Network Clusters. |
passwordAndUserAuth required | boolean Enables Password Authentication and User Authorization. |
name required | string [ 3 .. 48 ] characters [a-zA-Z0-9][a-zA-Z0-9_-]* Name of the cluster. |
Array of objects (ResizeSettingsV2) <= 1 items Settings to determine how resize requests will be performed for the cluster. | |
slaTier required | string (SlaTierV2) SLA Tier of the cluster. Non-production clusters may receive lower priority support and reduced SLAs. Production tier is not available when using Developer class nodes. See SLA Tier for more information. |
Valkey Cluster provisioning requested.
{- "clientToNodeEncryption": true,
- "dataCentres": [
- {
- "cloudProvider": "AWS_VPC",
- "masterNodes": 3,
- "name": "AWS_VPC_US_EAST_1",
- "network": "10.0.0.0/16",
- "nodeSize": "r6g.large-100-r",
- "nodes": [
- {
- "id": "94c1ad54-c6f1-4f2e-8634-be9f5fb47fad",
- "nodeRoles": [
- "VALKEY"
], - "nodeSize": "r6g.large-100-r",
- "privateAddress": "10.0.5.23",
- "publicAddress": "24.135.55.176",
- "rack": "us-east-1c",
- "startTime": "2024-10-03T00:58:27.587Z",
- "status": "RUNNING"
}, - {
- "id": "cc317853-be79-4100-898f-c12e4610a892",
- "nodeRoles": [
- "VALKEY"
], - "nodeSize": "r6g.large-100-r",
- "privateAddress": "10.0.128.45",
- "publicAddress": "193.146.159.238",
- "rack": "us-east-1c",
- "startTime": "2024-10-03T00:58:27.587Z",
- "status": "RUNNING"
}, - {
- "id": "b401b5bb-8a6f-4aa7-99c4-12fe445941c3",
- "nodeRoles": [
- "VALKEY"
], - "nodeSize": "r6g.large-100-r",
- "privateAddress": "10.0.200.78",
- "publicAddress": "108.21.43.134",
- "rack": "us-east-1c",
- "startTime": "2024-10-03T00:58:27.587Z",
- "status": "RUNNING"
}
], - "region": "US_EAST_1",
- "replicaNodes": 3
}
], - "name": "MyTestCluster",
- "passwordAndUserAuth": true,
- "pciComplianceMode": false,
- "privateNetworkCluster": false,
- "slaTier": "PRODUCTION",
- "valkeyVersion": "[x.y.z]"
}
{- "clientToNodeEncryption": true,
- "dataCentres": [
- {
- "cloudProvider": "AWS_VPC",
- "masterNodes": 3,
- "name": "AWS_VPC_US_EAST_1",
- "network": "10.0.0.0/16",
- "nodeSize": "r6g.large-100-r",
- "nodes": [
- {
- "id": "94c1ad54-c6f1-4f2e-8634-be9f5fb47fad",
- "nodeRoles": [
- "VALKEY"
], - "nodeSize": "r6g.large-100-r",
- "privateAddress": "10.0.5.23",
- "publicAddress": "24.135.55.176",
- "rack": "us-east-1c",
- "startTime": "2024-10-03T00:58:27.587Z",
- "status": "RUNNING"
}, - {
- "id": "cc317853-be79-4100-898f-c12e4610a892",
- "nodeRoles": [
- "VALKEY"
], - "nodeSize": "r6g.large-100-r",
- "privateAddress": "10.0.128.45",
- "publicAddress": "193.146.159.238",
- "rack": "us-east-1c",
- "startTime": "2024-10-03T00:58:27.587Z",
- "status": "RUNNING"
}, - {
- "id": "b401b5bb-8a6f-4aa7-99c4-12fe445941c3",
- "nodeRoles": [
- "VALKEY"
], - "nodeSize": "r6g.large-100-r",
- "privateAddress": "10.0.200.78",
- "publicAddress": "108.21.43.134",
- "rack": "us-east-1c",
- "startTime": "2024-10-03T00:58:27.587Z",
- "status": "RUNNING"
}
], - "region": "US_EAST_1",
- "replicaNodes": 3
}
], - "name": "MyTestCluster",
- "passwordAndUserAuth": true,
- "pciComplianceMode": false,
- "privateNetworkCluster": false,
- "slaTier": "PRODUCTION",
- "valkeyVersion": "[x.y.z]"
}
Valkey cluster details retrieved.
{- "clientToNodeEncryption": true,
- "dataCentres": [
- {
- "cloudProvider": "AWS_VPC",
- "masterNodes": 3,
- "name": "AWS_VPC_US_EAST_1",
- "network": "10.0.0.0/16",
- "nodeSize": "r6g.large-100-r",
- "nodes": [
- {
- "id": "94c1ad54-c6f1-4f2e-8634-be9f5fb47fad",
- "nodeRoles": [
- "VALKEY"
], - "nodeSize": "r6g.large-100-r",
- "privateAddress": "10.0.5.23",
- "publicAddress": "24.135.55.176",
- "rack": "us-east-1c",
- "startTime": "2024-10-03T00:58:27.587Z",
- "status": "RUNNING"
}, - {
- "id": "cc317853-be79-4100-898f-c12e4610a892",
- "nodeRoles": [
- "VALKEY"
], - "nodeSize": "r6g.large-100-r",
- "privateAddress": "10.0.128.45",
- "publicAddress": "193.146.159.238",
- "rack": "us-east-1c",
- "startTime": "2024-10-03T00:58:27.587Z",
- "status": "RUNNING"
}, - {
- "id": "b401b5bb-8a6f-4aa7-99c4-12fe445941c3",
- "nodeRoles": [
- "VALKEY"
], - "nodeSize": "r6g.large-100-r",
- "privateAddress": "10.0.200.78",
- "publicAddress": "108.21.43.134",
- "rack": "us-east-1c",
- "startTime": "2024-10-03T00:58:27.587Z",
- "status": "RUNNING"
}
], - "region": "US_EAST_1",
- "replicaNodes": 3
}
], - "name": "MyTestCluster",
- "passwordAndUserAuth": true,
- "pciComplianceMode": false,
- "privateNetworkCluster": false,
- "slaTier": "PRODUCTION",
- "valkeyVersion": "[x.y.z]"
}
Valkey cluster update request accepted.
Valkey cluster not found
{- "dataCentres": [
- {
- "replicationFactor": 1,
- "awsSettings": [
- {
- "ebsEncryptionKey": "9a27373a-0451-4121-94ba-873fc441f313",
- "customVirtualNetworkId": "string"
}
], - "network": "192.168.0.0/18",
- "tags": [
- {
- "value": "myTagValue",
- "key": "myTagKey"
}
], - "gcpSettings": [
- {
- "customVirtualNetworkId": "string"
}
], - "nodeSize": "t3.small-20-r",
- "cloudProvider": "AWS_VPC",
- "azureSettings": [
- {
- "resourceGroup": "string",
- "customVirtualNetworkId": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.Network/virtualNetworks/{virtual-network-name}",
- "storageNetwork": "192.168.1.0/24"
}
], - "masterNodes": 3,
- "name": "US_EAST_1_DC",
- "replicaNodes": 3,
- "region": "US_EAST_1",
- "privateLink": [
- {
- "advertisedHostname": "test.com"
}
], - "providerAccountName": "string"
}
], - "description": "Cluster managed by the integration team.",
- "twoFactorDelete": [
- {
- "confirmationPhoneNumber": "string",
- "confirmationEmail": "string"
}
], - "resizeSettings": [
- {
- "notifySupportContacts": true,
- "concurrency": 0
}
]
}
{- "clientToNodeEncryption": true,
- "dataCentres": [
- {
- "cloudProvider": "AWS_VPC",
- "masterNodes": 3,
- "name": "AWS_VPC_US_EAST_1",
- "network": "10.0.0.0/16",
- "nodeSize": "r6g.large-100-r",
- "nodes": [
- {
- "id": "94c1ad54-c6f1-4f2e-8634-be9f5fb47fad",
- "nodeRoles": [
- "VALKEY"
], - "nodeSize": "r6g.large-100-r",
- "privateAddress": "10.0.5.23",
- "publicAddress": "24.135.55.176",
- "rack": "us-east-1c",
- "startTime": "2024-10-03T00:58:27.587Z",
- "status": "RUNNING"
}, - {
- "id": "cc317853-be79-4100-898f-c12e4610a892",
- "nodeRoles": [
- "VALKEY"
], - "nodeSize": "r6g.large-100-r",
- "privateAddress": "10.0.128.45",
- "publicAddress": "193.146.159.238",
- "rack": "us-east-1c",
- "startTime": "2024-10-03T00:58:27.587Z",
- "status": "RUNNING"
}, - {
- "id": "b401b5bb-8a6f-4aa7-99c4-12fe445941c3",
- "nodeRoles": [
- "VALKEY"
], - "nodeSize": "r6g.large-100-r",
- "privateAddress": "10.0.200.78",
- "publicAddress": "108.21.43.134",
- "rack": "us-east-1c",
- "startTime": "2024-10-03T00:58:27.587Z",
- "status": "RUNNING"
}
], - "region": "US_EAST_1",
- "replicaNodes": 3
}
], - "name": "MyTestCluster",
- "passwordAndUserAuth": true,
- "pciComplianceMode": false,
- "privateNetworkCluster": false,
- "slaTier": "PRODUCTION",
- "valkeyVersion": "[x.y.z]"
}