Skip to content

Commit 644f2a3

Browse files
committed
Update docu for enhanced /v3/info/usage_summary endpoint
1 parent 5a6d3bf commit 644f2a3

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed

docs/v3/source/includes/api_resources/_info.erb

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,13 @@
4242
{
4343
"usage_summary": {
4444
"started_instances": 294,
45-
"memory_in_mb": 123945
45+
"memory_in_mb": 123945,
46+
"routes": 300,
47+
"service_instances": 50,
48+
"reserved_ports": 10,
49+
"domains": 5,
50+
"per_app_tasks": 0,
51+
"service_keys": 20
4652
},
4753
"links": {
4854
"self": { "href": "http://api.example.com/v3/info/usage_summary" }

docs/v3/source/includes/resources/info/_get_usage_summary.md.erb

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,16 @@ This endpoint retrieves a high-level summary of usage across the entire Cloud Fo
2727

2828
#### Usage summary object
2929

30-
| Name | Type | Description |
31-
| ---- | ---- | ----------- |
32-
| **started_instances** | _integer_ | Total number of process instances in the `STARTED` state |
33-
| **memory_in_mb** | _integer_ | Sum of memory usage of all tasks in the `RUNNING` state and all process instances in the `STARTED` state |
30+
| Name | Type | Description |
31+
|-----------------------|-----------|----------------------------------------------------------------------------------------------------------|
32+
| **started_instances** | _integer_ | Total number of process instances in the `STARTED` state |
33+
| **memory_in_mb** | _integer_ | Sum of memory usage of all tasks in the `RUNNING` state and all process instances in the `STARTED` state |
34+
| **routes** | _integer_ | Total number of routes |
35+
| **service_instances** | _integer_ | Total number of service instances |
36+
| **reserved_ports** | _integer_ | Total number of reserved ports |
37+
| **domains** | _integer_ | Total number of private domains |
38+
| **per_app_tasks** | _integer_ | Total number of running tasks |
39+
| **service_keys** | _integer_ | Total number of service keys |
3440

3541
#### Permitted roles
3642

0 commit comments

Comments
 (0)