reference_product_availabilities
Creates, updates, deletes, gets or lists a reference_product_availabilities resource.
Overview​
| Name | reference_product_availabilities |
| Type | Resource |
| Id | ovh.public_cloud.reference_product_availabilities |
Fields​
The following fields are returned by SELECT queries:
- list
Product type availability (read-only reference data). Groups the offerings of a single product type available to a Public Cloud project. The endpoint returns one group per product type. This is read-only reference data computed from the OVHcloud commercial catalog combined with the project's entitlements. It does not reflect existing resources and triggers no OpenStack call.
| Name | Datatype | Description |
|---|---|---|
models | array | The offerings of this product type available to the project, each with its per-location availability. Null or empty when no model is available. |
type | string | Product type. The product family this group describes. Groups come in this order: INSTANCE, VOLUME, LOADBALANCER, GATEWAY, FLOATING_IP, PUBLIC_IP, VOLUME_SNAPSHOT, VOLUME_BACKUP, INSTANCE_SNAPSHOT, SHARE, SHARE_SNAPSHOT, OBJECT_STORAGE, SWIFT. (FLOATING_IP, GATEWAY, INSTANCE, INSTANCE_SNAPSHOT, LOADBALANCER, OBJECT_STORAGE, PUBLIC_IP, SHARE, SHARE_SNAPSHOT, SWIFT, VOLUME, VOLUME_BACKUP, VOLUME_SNAPSHOT) |
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, name_contains, region, type | ### Product availability<br /><br />Returns the products available to this Public Cloud project, grouped by product type.<br /><br />This is read-only reference data: the response is computed from the OVHcloud commercial catalog combined with the project's entitlements and its quota usage. It does not reflect existing resources and triggers no OpenStack call.<br /><br />The response is an array with one entry per product type, in this order: INSTANCE, VOLUME, LOADBALANCER, GATEWAY, FLOATING_IP, PUBLIC_IP, VOLUME_SNAPSHOT, VOLUME_BACKUP, INSTANCE_SNAPSHOT, SHARE, SHARE_SNAPSHOT, OBJECT_STORAGE, SWIFT. Each type group carries its models. Each model carries the locations where it is sold to the project, in the regions activated on the project and in those the project can activate. Each location reports its availability zones, regionActivated, a quotaStatus with the quota resources that block it (quotaLimitedBy) and, for the INSTANCE type only, a stockStatus per availability zone.<br /><br />links point to related operations: a SPECS link on a model leads to the reference route describing it, and a location whose quotaStatus is INSUFFICIENT carries a QUOTA link.<br /><br />Every filter is optional: type keeps the group of that product type only, region the locations of that region (letter case ignored), name the models with exactly that name and nameContains the models whose name contains that value (letter case ignored). |
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 exact model name filter, for example b3-8 |
name_contains | string | Optional model name filter keeping the names that contain this value, letter case ignored (wire: nameContains) |
region | string | Optional region filter, letter case ignored |
type | string | Optional product type filter |
x_pagination_cursor | string | Pagination cursor (wire: X-Pagination-Cursor) |
x_pagination_size | integer | Pagination size (wire: X-Pagination-Size) |
SELECT examples​
- list
Product availability<br /><br />Returns the products available to this Public Cloud project, grouped by product type.<br /><br />This is read-only reference data: the response is computed from the OVHcloud commercial catalog combined with the project's entitlements and its quota usage. It does not reflect existing resources and triggers no OpenStack call.<br /><br />The response is an array with one entry per product type, in this order: INSTANCE, VOLUME, LOADBALANCER, GATEWAY, FLOATING_IP, PUBLIC_IP, VOLUME_SNAPSHOT, VOLUME_BACKUP, INSTANCE_SNAPSHOT, SHARE, SHARE_SNAPSHOT, OBJECT_STORAGE, SWIFT. Each type group carries its models. Each model carries the locations where it is sold to the project, in the regions activated on the project and in those the project can activate. Each location reports its availability zones, regionActivated, a quotaStatus with the quota resources that block it (quotaLimitedBy) and, for the INSTANCE type only, a stockStatus per availability zone.<br /><br />links point to related operations: a SPECS link on a model leads to the reference route describing it, and a location whose quotaStatus is INSUFFICIENT carries a QUOTA link.<br /><br />Every filter is optional: type keeps the group of that product type only, region the locations of that region (letter case ignored), name the models with exactly that name and nameContains the models whose name contains that value (letter case ignored).​
SELECT
models,
type
FROM ovh.public_cloud.reference_product_availabilities
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 name_contains = '{{ name_contains }}'
AND region = '{{ region }}'
AND type = '{{ type }}'
;