reference_gateway_models
Creates, updates, deletes, gets or lists a reference_gateway_models resource.
Overview​
| Name | reference_gateway_models |
| Type | Resource |
| Id | ovh.public_cloud.reference_gateway_models |
Fields​
The following fields are returned by SELECT queries:
- list
A gateway model and its bandwidth in one region. A model sold in several regions appears once per region.
| Name | Datatype | Description |
|---|---|---|
name | string | Model name, to use as the model when creating a gateway (2XL, 3XL, L, M, S, XL) |
bandwidth | integer | Bandwidth in Mbit/s |
location | object | Region where the model is sold to the project, whether that region is already activated on the project (regionActivated), and the availability zones of that region (availabilityZones), empty for a single-AZ region |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | project_id | x_pagination_cursor, x_pagination_size, name, region | Returns the gateway models with their bandwidth in Mbit/s, read from the OVHcloud commercial catalog. The list holds one entry per model and region: a model sold in several regions appears once per region, with the bandwidth of that region and the region in location. The regions already activated on the project and those the project can activate where a model is sold are both listed. location.regionActivated on each entry tells which regions must be activated on the project before use. location.availabilityZones lists the availability zones of the region, for example eu-west-par-a, eu-west-par-b and eu-west-par-c, and is empty for a single-AZ region. Models come smallest first, each sorted by region name. Use name as the model when creating a gateway. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
project_id | string | The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set. |
name | string | Optional model filter, for example S |
region | string | Optional region filter, case-insensitive. Keeps the entries of this region only. A region that does not exist is rejected. One the project can neither use nor activate returns an empty list. |
x_pagination_cursor | string | Pagination cursor (wire: X-Pagination-Cursor) |
x_pagination_size | integer | Pagination size (wire: X-Pagination-Size) |
SELECT examples​
- list
Returns the gateway models with their bandwidth in Mbit/s, read from the OVHcloud commercial catalog. The list holds one entry per model and region: a model sold in several regions appears once per region, with the bandwidth of that region and the region in location. The regions already activated on the project and those the project can activate where a model is sold are both listed. location.regionActivated on each entry tells which regions must be activated on the project before use. location.availabilityZones lists the availability zones of the region, for example eu-west-par-a, eu-west-par-b and eu-west-par-c, and is empty for a single-AZ region. Models come smallest first, each sorted by region name. Use name as the model when creating a gateway.
SELECT
name,
bandwidth,
location
FROM ovh.public_cloud.reference_gateway_models
WHERE project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
AND name = '{{ name }}'
AND region = '{{ region }}'
;