Skip to content

Commit e55a34e

Browse files
committed
chore: be consistent with shard count and shard placement
1 parent 4254c2e commit e55a34e

File tree

1 file changed

+40
-10
lines changed

1 file changed

+40
-10
lines changed

docs/valkey/http-api.md

Lines changed: 40 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,16 @@ Creates a new Valkey Cluster with the specified configuration.
5757
"shard_index": 0,
5858
"availability_zone": "us-east-1a",
5959
"replica_availability_zones": ["us-east-1b", "us-east-1c"]
60+
},
61+
{
62+
"shard_index": 1,
63+
"availability_zone": "us-east-1a",
64+
"replica_availability_zones": ["us-east-1b", "us-east-1c"]
65+
},
66+
{
67+
"shard_index": 2,
68+
"availability_zone": "us-east-1a",
69+
"replica_availability_zones": ["us-east-1b", "us-east-1c"]
6070
}
6171
]
6272
}
@@ -92,6 +102,16 @@ Creates a new Valkey Cluster with the specified configuration.
92102
"shard_index": 0,
93103
"availability_zone": "us-east-1a",
94104
"replica_availability_zones": ["us-east-1b", "us-east-1c"]
105+
},
106+
{
107+
"shard_index": 1,
108+
"availability_zone": "us-east-1a",
109+
"replica_availability_zones": ["us-east-1b", "us-east-1c"]
110+
},
111+
{
112+
"shard_index": 2,
113+
"availability_zone": "us-east-1a",
114+
"replica_availability_zones": ["us-east-1b", "us-east-1c"]
95115
}
96116
],
97117
"status": "Creating"
@@ -163,6 +183,16 @@ Retrieves the details of a specific Valkey Cluster.
163183
"shard_index": 0,
164184
"availability_zone": "us-east-1a",
165185
"replica_availability_zones": ["us-east-1b", "us-east-1c"]
186+
},
187+
{
188+
"shard_index": 1,
189+
"availability_zone": "us-east-1a",
190+
"replica_availability_zones": ["us-east-1b", "us-east-1c"]
191+
},
192+
{
193+
"shard_index": 2,
194+
"availability_zone": "us-east-1a",
195+
"replica_availability_zones": ["us-east-1b", "us-east-1c"]
166196
}
167197
],
168198
"status": "Active"
@@ -509,7 +539,7 @@ Decreases the number of replicas per shard for an existing cluster.
509539

510540
# Examples
511541

512-
## Create Cluster
542+
## Example: Create Cluster
513543

514544
Create a new Valkey Cluster with 3 shards and 2 replicas per shard:
515545

@@ -545,15 +575,15 @@ curl -X POST -H "Authorization: <token>" \
545575
},
546576
{
547577
"shard_index": 1,
548-
"availability_zone": "us-east-1b",
549-
"replica_availability_zones": ["us-east-1a", "us-east-1c"]
578+
"availability_zone": "us-east-1a",
579+
"replica_availability_zones": ["us-east-1b", "us-east-1c"]
550580
}
551581
]
552582
}' \
553583
"https://api.cache.cell-1-us-east-1-1.prod.a.momentohq.com/ec-cluster"
554584
```
555585

556-
## Describe Cluster
586+
## Example: Describe Cluster
557587

558588
Get details for a specific cluster:
559589

@@ -562,7 +592,7 @@ curl -H "Authorization: <token>" \
562592
"https://api.cache.cell-1-us-east-1-1.prod.a.momentohq.com/ec-cluster/my-cluster"
563593
```
564594

565-
## List Clusters
595+
## Example: List Clusters
566596

567597
List all clusters in your account:
568598

@@ -571,7 +601,7 @@ curl -H "Authorization: <token>" \
571601
"https://api.cache.cell-1-us-east-1-1.prod.a.momentohq.com/ec-cluster"
572602
```
573603

574-
## Update Replication Group
604+
## Example: Update Replication Group
575605

576606
Change the instance type:
577607

@@ -584,7 +614,7 @@ curl -X POST -H "Authorization: <token>" \
584614
"https://api.cache.cell-1-us-east-1-1.prod.a.momentohq.com/ec-cluster/my-cluster/replication-group"
585615
```
586616

587-
## Update Shard Configuration
617+
## Example: Update Shard Configuration
588618

589619
Scale up from 3 shards to 5 shards:
590620

@@ -609,7 +639,7 @@ curl -X POST -H "Authorization: <token>" \
609639
"https://api.cache.cell-1-us-east-1-1.prod.a.momentohq.com/ec-cluster/my-cluster/shard-configuration"
610640
```
611641

612-
## Increase Replica Count
642+
## Example: Increase Replica Count
613643

614644
Increase replicas from 2 to 3 per shard:
615645

@@ -622,7 +652,7 @@ curl -X POST -H "Authorization: <token>" \
622652
"https://api.cache.cell-1-us-east-1-1.prod.a.momentohq.com/ec-cluster/my-cluster/increase-replica-count"
623653
```
624654

625-
## Decrease Replica Count
655+
## Example: Decrease Replica Count
626656

627657
Decrease replicas from 3 to 1 per shard:
628658

@@ -635,7 +665,7 @@ curl -X POST -H "Authorization: <token>" \
635665
"https://api.cache.cell-1-us-east-1-1.prod.a.momentohq.com/ec-cluster/my-cluster/decrease-replica-count"
636666
```
637667

638-
## Delete Cluster
668+
## Example: Delete Cluster
639669

640670
Delete a cluster:
641671

0 commit comments

Comments
 (0)