reference_regions
Creates, updates, deletes, gets or lists a reference_regions resource.
Overview​
| Name | reference_regions |
| Type | Resource |
| Id | ovh.okms.reference_regions |
Fields​
The following fields are returned by SELECT queries:
- list
Region information
| Name | Datatype | Description |
|---|---|---|
id | string | Name of the region (ap-south-mum, ap-southeast-sgp, ap-southeast-syd, ca-east-bhs, ca-east-tor, eu-central-waw, eu-south-mil, eu-west-eri, eu-west-gra, eu-west-lim, eu-west-par, eu-west-rbx, eu-west-sbg) |
certifications | array | Certifications of the region |
kmip_endpoint | string | KMS kmip API endpoint (wire: kmipEndpoint) |
rest_endpoint | string | KMS rest API endpoint (wire: restEndpoint) |
type | string | General typology of the region (LOCAL-ZONE, REGION-1-AZ, REGION-3-AZ) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | x_pagination_cursor, x_pagination_size | Returns the regions where a service can be ordered, with their certifications and the KMIP and REST endpoints of each. |
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"}}) |
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 regions where a service can be ordered, with their certifications and the KMIP and REST endpoints of each.
SELECT
id,
certifications,
kmip_endpoint,
rest_endpoint,
type
FROM ovh.okms.reference_regions
WHERE x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;