Update quota/usage API info for v3

Update the page about the s11stack-manager API to document API version v3
syseleven · Jun 20, 2024 · 0f86ebd · 0f86ebd
1 parent 0c684e2
commit 0f86ebd
Showing 1 changed file with 134 additions and 16 deletions.
diff --git a/user/pages/04.Reference/10.get-quota-info/docs.en.md b/user/pages/04.Reference/10.get-quota-info/docs.en.md
@@ -40,23 +40,24 @@ token=$(openstack token issue -c id -f value)
 
 ### API versions
 
-There are 2 versions of the API: v1 and v2. Version v2 extends the data schema for usage and quota API endpoints to add values related to Octavia load balancers. The following examples use v2-based URLs, but v1 is still supported (just replace v2 with v1 in the URL).
+The current API version is v3. Version v3 and v2 extended the data schema for usage and quota API endpoints.
+The following examples use v3-based URLs, but v1 and v2 are still supported (just replace v3 in the URL).
 
 ### Query quota limits
 
 #### URL
 
 ```plain
-GET https://api.cloud.syseleven.net:5001/v2/projects/{project_id}/quota
+GET https://api.cloud.syseleven.net:5001/v3/projects/{project_id}/quota
 ```
 
 #### Request parameters
 
-| Name         | Where    | Description |
-| ------------ | -------- | ----------- |
-| project_id   | URL path | The OpenStack project ID. It needs to be the same as the one the token was created with. |
-| X-Auth-Token | Header   | Token for authenticating the request. |
-| regions      | URL query parameter | Optionally restrict the regions to be queried. Comma-separated list of region names. If no region is given here, all regions are queried. |
+| Name         | Where    | Description |
+| ------------ | -------- | ----------- |
+| project_id   | URL path | The OpenStack project ID. It needs to be the same as the one the token was created with. |
+| X-Auth-Token | Header   | Token for authenticating the request. |
+| regions      | URL query parameter | Optionally restrict the regions to be queried. Comma-separated list of region names. If no region is given here, all regions are queried. |
 
 Example:
 
@@ -65,7 +66,7 @@ Example:
 
 ```shell
 token=$(openstack token issue -c id -f value)
-curl -H "X-Auth-Token: $token" 'https://api.cloud.syseleven.net:5001/v2/projects/11111111111111111111111111111111/quota?regions=cbk,fes'
+curl -H "X-Auth-Token: $token" 'https://api.cloud.syseleven.net:5001/v3/projects/11111111111111111111111111111111/quota?regions=cbk,fes'
 ```
 
 #### Response
@@ -77,7 +78,11 @@ The response contains the quota information in JSON format. Example for a respon
   "cbk": {
     "compute.cores": 50,
     "compute.instances": 50,
+    "compute.key_pairs": 1024,
+    "compute.metadata_items": 1024,
     "compute.ram_mb": 204800,
+    "compute.server_group_members": 2048,
+    "compute.server_groups": 1024,
     "dns.zones": 10,
     "loadbalancer.healthmonitors": 200,
     "loadbalancer.listeners": 200,
@@ -90,32 +95,72 @@ The response contains the quota information in JSON format. Example for a respon
     "network.lb_members": 128,
     "network.lb_pools": 128,
     "network.loadbalancers": 1024,
+    "network.networks": 1024,
+    "network.ports": 1024,
+    "network.rbac_policies": 128,
+    "network.routers": 128,
+    "network.security_group_rules": 2048,
+    "network.security_groups": 1024,
+    "network.subnet_pools": -1,
+    "network.subnets": 1024,
     "network.vpn_endpoint_groups": -1,
     "network.vpn_ikepolicies": -1,
     "network.vpn_ipsec_site_connections": -1,
     "network.vpn_ipsecpolicies": -1,
     "network.vpn_services": -1,
-    "s3.space_bytes": 4294967296,
+    "objectstorage": [
+      {
+        "space_bytes": 4294967296,
+        "type": "quobyte"
+      }
+    ],
+    "volume.backup_gb": 0,
+    "volume.backups": 0,
+    "volume.snapshots": 1024,
     "volume.space_gb": 1000,
     "volume.volumes": 1024
   },
   "fes": {
     "compute.cores": 60,
     "compute.instances": 60,
+    "compute.key_pairs": 1024,
+    "compute.metadata_items": 1024,
     "compute.ram_mb": 245760,
+    "compute.server_group_members": 2048,
+    "compute.server_groups": 1024,
     "dns.zones": 10,
     "loadbalancer.healthmonitors": 200,
     "loadbalancer.listeners": 200,
     "loadbalancer.loadbalancers": 15,
     "loadbalancer.members": 300,
     "loadbalancer.pools": 200,
     "network.floatingips": 50,
+    "network.networks": 1024,
+    "network.ports": 1024,
+    "network.rbac_policies": 128,
+    "network.routers": 128,
+    "network.security_group_rules": 2048,
+    "network.security_groups": 1024,
+    "network.subnet_pools": -1,
+    "network.subnets": 1024,
     "network.vpn_endpoint_groups": -1,
     "network.vpn_ikepolicies": -1,
     "network.vpn_ipsec_site_connections": -1,
     "network.vpn_ipsecpolicies": -1,
     "network.vpn_services": -1,
-    "s3.space_bytes": -1,
+    "objectstorage": [
+      {
+        "space_bytes": 0,
+        "type": "quobyte"
+      },
+      {
+        "space_bytes": 549755813888,
+        "type": "ceph"
+      }
+    ],
+    "volume.backup_gb": 0,
+    "volume.backups": 0,
+    "volume.snapshots": 1024,
     "volume.space_gb": 1000,
     "volume.volumes": 1024
   }
@@ -128,7 +173,11 @@ Overview of fields:
 | ----- | ----------- | ----- |
 | compute.cores | Number of virtual cores | |
 | compute.instances | Number of virtual machines (servers, instances) | |
+| compute.key_pairs | Number of key pairs per user | since v3 |
+| compute.metadata_items | Number of allowed metadata items per server | since v3 |
 | compute.ram_mb | RAM for virtual machines in MiB | |
+| compute.server_group_members | Number of allowed members for each server group | since v3 |
+| compute.server_groups | Number of server groups | since v3 |
 | dns.zones | Number of DNS zones | |
 | loadbalancer.healthmonitors | Number of Octavia LBaaS health monitors | since v2 |
 | loadbalancer.listeners | Number of Octavia LBaaS listeners | since v2 |
@@ -141,12 +190,24 @@ Overview of fields:
 | network.lb_members | Number of Neutron LBaaS v2 pool members | only in regions cbk and dbl |
 | network.lb_pools | Number of Neutron LBaaS v2 pools | only in regions cbk and dbl |
 | network.loadbalancers | Number of Neutron LBaaS v2 load balancers | only in regions cbk and dbl |
+| network.networks | Number of networks | since v3 |
+| network.ports | Number of ports | since v3 |
+| network.rbac_policies | Number of role-based access control (RBAC) policies | since v3 |
+| network.routers | Number of routers | since v3 |
+| network.security_group_rules | Number of security group rules | since v3 |
+| network.security_groups | Number of security groups | since v3 |
+| network.subnet_pools | Number of subnet pools | since v3 |
+| network.subnets | Number of subnets | since v3 |
 | network.vpn_endpoint_groups | Number of VPNaaS endpoint groups | |
 | network.vpn_ikepolicy | Number of VPNaaS IKE policies | |
 | network.vpn_ipsec_site_connections | Number of VPNaaS site connections | |
 | network.vpn_ipsecpolicies | Number of VPNaaS IPSec policies | |
 | network.vpn_services | Number of VPNaaS VPN services | |
-| s3.space_bytes | Limit of Object Storage (S3) size in bytes | |
+| objectstorage | List of Object Storage (S3) size limits per type | since v3 |
+| s3.space_bytes | Limit of Object Storage (S3) size in bytes | v1 and v2 |
+| volume.backup_gb | Limit of total size of volume backups in GiB | since v3 |
+| volume.backups | Number of volume backups | since v3 |
+| volume.snapshots | Number of volume snapshots | since v3 |
 | volume.space_gb | Limit of Block Storage size (for volumes) in GiB | |
 | volume.volumes | Number of Block Storage volumes | |
 
@@ -157,7 +218,7 @@ A limit of -1 means "unlimited", 0 means "no resources".
 #### URL
 
 ```plain
-GET https://api.cloud.syseleven.net:5001/v2/projects/{project_id}/current_usage
+GET https://api.cloud.syseleven.net:5001/v3/projects/{project_id}/current_usage
 ```
 
 #### Request parameters
@@ -195,7 +256,7 @@ Example:
 
 ```shell
 token=$(openstack token issue -c id -f value)
-curl -H "X-Auth-Token: $token" 'https://api.cloud.syseleven.net:5001/v2/projects/11111111111111111111111111111111/current_usage?regions=cbk,fes&filter=compute,s3'
+curl -H "X-Auth-Token: $token" 'https://api.cloud.syseleven.net:5001/v3/projects/11111111111111111111111111111111/current_usage?regions=cbk,fes&filter=compute,s3'
 ```
 
 #### Response
@@ -211,7 +272,10 @@ The response contains the information about the currently-used resources in JSON
     },
     "compute.instances": 3,
     "compute.ram_mb": 6144,
+    "compute.server_groups": 0,
     "dns.zones": 2,
+    "image.images": 0,
+    "image.space_bytes": 0,
     "loadbalancer.flavors": {
       "failover-small": 1
     },
@@ -226,12 +290,28 @@ The response contains the information about the currently-used resources in JSON
     "network.lb_members": 0,
     "network.lb_pools": 0,
     "network.loadbalancers": 0,
+    "network.networks": 0,
+    "network.ports": 0,
+    "network.rbac_policies": 0,
+    "network.routers": 0,
+    "network.security_group_rules": 0,
+    "network.security_groups": 0,
+    "network.subnet_pools": 0,
+    "network.subnets": 0,
     "network.vpn_endpoint_groups": 0,
     "network.vpn_ikepolicies": 1,
     "network.vpn_ipsec_site_connections": 1,
     "network.vpn_ipsecpolicies": 1,
     "network.vpn_services": 1,
-    "s3.space_bytes": 48,
+    "objectstorage": [
+      {
+        "space_bytes": 0,
+        "type": "quobyte"
+      }
+    ],
+    "volume.backup_gb": 0,
+    "volume.backups": 0,
+    "volume.snapshots": 0,
     "volume.space_gb": 6,
     "volume.volumes": 4
   },
@@ -244,7 +324,10 @@ The response contains the information about the currently-used resources in JSON
     },
     "compute.instances": 9,
     "compute.ram_mb": 204800,
+    "compute.server_groups": 0,
     "dns.zones": 2,
+    "image.images": 0,
+    "image.space_bytes": 0,
     "loadbalancer.flavors": {
       "failover-small": 2,
       "standalone-tiny": 1
@@ -255,12 +338,32 @@ The response contains the information about the currently-used resources in JSON
     "loadbalancer.members": 6,
     "loadbalancer.pools": 3,
     "network.floatingips": 10,
+    "network.networks": 0,
+    "network.ports": 0,
+    "network.rbac_policies": 0,
+    "network.routers": 0,
+    "network.security_group_rules": 0,
+    "network.security_groups": 0,
+    "network.subnet_pools": 0,
+    "network.subnets": 0,
     "network.vpn_endpoint_groups": 0,
     "network.vpn_ikepolicies": 1,
     "network.vpn_ipsec_site_connections": 1,
     "network.vpn_ipsecpolicies": 1,
     "network.vpn_services": 1,
-    "s3.space_bytes": 12,
+    "objectstorage": [
+      {
+        "space_bytes": 0,
+        "type": "quobyte"
+      },
+      {
+        "space_bytes": 0,
+        "type": "ceph"
+      }
+    ],
+    "volume.backup_gb": 0,
+    "volume.backups": 0,
+    "volume.snapshots": 0,
     "volume.space_gb": 133,
     "volume.volumes": 7
   }
@@ -273,7 +376,10 @@ The response contains the information about the currently-used resources in JSON
 | compute.flavors | Number of virtual machines per flavor | |
 | compute.instances | Total number of virtual machines | |
 | compute.ram_mb | Total RAM of virtual machines in MiB | |
+| compute.server_groups | Number of server groups | since v3 |
 | dns.zones | Number of DNS zones | |
+| image.images | Number of images | since v3 |
+| image.space_bytes | Total size of images | since v3 |
 | loadbalancer.flavors | Number of Octavia LBaaS load balancers per flavor | since v2 |
 | loadbalancer.healthmonitors | Number of Octavia LBaaS health monitors | since v2 |
 | loadbalancer.listeners | Number of Octavia LBaaS  listeners | since v2 |
@@ -286,12 +392,24 @@ The response contains the information about the currently-used resources in JSON
 | network.lb_members | Number of Neutron LBaaS v2 pool members | only in regions cbk and dbl |
 | network.lb_pools | Number of Neutron LBaaS v2 pools | only in regions cbk and dbl |
 | network.loadbalancers | Number of Neutron LBaaS v2 load balancers | only in regions cbk and dbl |
+| network.networks | Number of networks | since v3 |
+| network.ports | Number of ports | since v3 |
+| network.rbac_policies | Number of role-based access control (RBAC) policies | since v3 |
+| network.routers | Number of routers | since v3 |
+| network.security_group_rules | Number of security group rules | since v3 |
+| network.security_groups | Number of security groups | since v3 |
+| network.subnet_pools | Number of subnet pools | since v3 |
+| network.subnets | Number of subnets | since v3 |
 | network.vpn_endpoint_groups | Number of VPNaaS endpoint groups | |
 | network.vpn_ikepolicy | Number of VPNaaS IKE policies | |
 | network.vpn_ipsec_site_connections | Number of VPNaaS site connections | |
 | network.vpn_ipsecpolicies | Number of VPNaaS IPSec policies | |
 | network.vpn_services | Number of VPNaaS VPN services | |
-| s3.space_bytes | Used size of Object Storage (S3) in Bytes | |
+| objectstorage | List of used sizes of Object Storage (S3) per type | since v3 |
+| s3.space_bytes | Used size of Object Storage (S3) in bytes | v1 and v2 |
+| volume.backup_gb | Total size of volume backups in GiB | since v3 |
+| volume.backups | Number of volume backups | since v3 |
+| volume.snapshots | Number of volume snapshots | since v3 |
 | volume.space_gb | Used size of Block Storage (volumes) in GiB | |
 | volume.volumes | Number of Block Storage volumes | |