Skip to main content

public_ips

Creates, updates, deletes, gets or lists a public_ips resource.

Overview​

Namepublic_ips
TypeResource
Idovh.public_cloud_network.public_ips

Fields​

The following fields are returned by SELECT queries:

Lightweight view of a Public Cloud public IP, exposing only its kind and address

NameDatatypeDescription
ipstring (ipv4)The public IP address (example: 192.0.2.0)
typestringKind of the public IP address (ADDITIONAL_IP, EXT_NET_IP, FLOATING_IP)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectproject_idx_pagination_cursor, x_pagination_sizeReturns every public IP address of the project with its kind, as a lightweight summary. For full details, use the additional, Ext-Net or floating IP routes.

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.

NameDatatypeDescription
api_hoststringThe 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_idstringThe Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
x_pagination_cursorstringPagination cursor (wire: X-Pagination-Cursor)
x_pagination_sizeintegerPagination size (wire: X-Pagination-Size)

SELECT examples​

Returns every public IP address of the project with its kind, as a lightweight summary. For full details, use the additional, Ext-Net or floating IP routes.

SELECT
ip,
type
FROM ovh.public_cloud_network.public_ips
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 }}'
;