Skip to content

Commit b8fc634

Browse files
DOC-11708 Deprecated REST API endpoint for bucket stats (#3859)
* Update rest-buckets-table.adoc * DOC-11708 Update rest-scopes-and-collections-table.adoc replaced '/pools/default/buckets' with '/pools/defaults/stats/range' * DOC-11708 Update rest-memory-and-storage-table.adoc replaced pools/default/buckets with /pools/defaults/stats/range * DOC-11708 Update rest-xdcr-table.adoc replaced /pools/default/buckets with /pools/defaults/stats/range * /DOC-11708 Update rest-buckets-table.adoc Updated post a conversation with Liam that only "/pools/default/buckets/[bucket-name]/stats" needs to change * /DOC-11708 Update rest-scopes-and-collections-table.adoc reverted earlier changes * /DOC-11708 Update rest-memory-and-storage-table.adoc reverted earlier changes * Update rest-buckets-table.adoc DOC-11708 replaced GET /pools/default/buckets/[bucket-name]/stats with GET /pools/default/stats/range and added a link to the Statistics page. * removed an extra slash in line 47 * Corrected original content updates * Added xdcr rest api for getting statistics * updated important note * Edited important note --------- Co-authored-by: rao-shwe <[email protected]>
1 parent b2b6ba9 commit b8fc634

File tree

3 files changed

+14
-6
lines changed

3 files changed

+14
-6
lines changed

modules/rest-api/pages/rest-bucket-stats.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
= Getting Bucket Statistics
2-
:description: pass:q[To retrieve bucket statistics, use the `GET` operation with the `/pools/default/buckets/bucket_name/stats` URI.]
2+
:description: pass:q[See the IMPORTANT note.]
33
:page-topic-type: reference
44
:page-aliases: rest-api:rest-node-retrieve-stats
55

6+
[.deprecated]#Deprecated#
7+
68
[abstract]
79
{description}
810

11+
IMPORTANT: As of Couchbase Server 8.0, the REST API endpoint `GET /pools/default/buckets/<bucket-name>/stats` is deprecated.
12+
For retrieving bucket statistics details, use xref:rest-api:rest-statistics-single.adoc[Getting a Single Statistic] or xref:rest-api:rest-statistics-multiple.adoc[Getting Multiple Statistics] instead.
13+
914
== HTTP method and URI
1015

1116
Statistics can be retrieved at the bucket level.

modules/rest-api/partials/rest-buckets-table.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,12 @@
2323
| xref:rest-api:rest-retrieve-bucket-nodes.adoc[Listing Nodes by Bucket]
2424

2525
| `GET`
26-
| `/pools/default/buckets/[bucket-name]/stats`
27-
| xref:rest-api:rest-bucket-stats.adoc[Getting Bucket Statistics]
26+
| `/pools/default/stats/range/[metric_name]/[function-expression]`
27+
| xref:rest-api:rest-statistics-single.adoc[Getting a Single Statistic]
28+
29+
| `POST`
30+
| `/pools/default/stats/range`
31+
| xref:rest-api:rest-statistics-multiple.adoc[Getting Multiple Statistics]
2832

2933
| `GET`
3034
| `/pools/default/buckets/default`

modules/rest-api/partials/rest-xdcr-table.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,8 @@
4242
| `/settings/replications/<settings_URI>`
4343
| xref:rest-api:rest-xdcr-adv-settings.adoc[Managing Advanced Settings]
4444

45-
4645
| `GET`
47-
| `/pools/default/buckets/[source_bucket]/stats/[destination_endpoint]`
48-
| xref:rest-api:rest-xdcr-statistics.adoc[Getting Statistics]
46+
| `/pools/default/stats/range/[statistics_name]`
47+
| xref:rest-api:rest-statistics-single.adoc[Getting a Single Statistic]
4948

5049
|===

0 commit comments

Comments
 (0)