public_ip_floatings

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

Overview

Name	public_ip_floatings
Type	Resource
Id	ovh.public_cloud_network.public_ip_floatings

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (ipv4)	The floating IP address, used as identifier (example: 192.0.2.0)
checksum	string	Computed hash representing the current target specification value
created_at	string (date-time)	Creation date of the floating IP (wire: createdAt)
current_state	object	Current state of the floating IP (wire: currentState)
current_tasks	array	Ongoing asynchronous tasks related to the floating IP (wire: currentTasks)
resource_status	string	Floating IP readiness in the system (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	Last target specification of the floating IP (wire: targetSpec)
updated_at	string (date-time)	Last update date of the floating IP (wire: updatedAt)

list

A Public Cloud floating public IP (keyed by IP address)

Name	Datatype	Description
id	string (ipv4)	The floating IP address, used as identifier (example: 192.0.2.0)
checksum	string	Computed hash representing the current target specification value
created_at	string (date-time)	Creation date of the floating IP (wire: createdAt)
current_state	object	Current state of the floating IP (wire: currentState)
current_tasks	array	Ongoing asynchronous tasks related to the floating IP (wire: currentTasks)
resource_status	string	Floating IP readiness in the system (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	Last target specification of the floating IP (wire: targetSpec)
updated_at	string (date-time)	Last update date of the floating IP (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, project_id		Returns the floating IP, including the resource it's currently associated with.
list	select	project_id	x_pagination_cursor, x_pagination_size	Returns the floating IPs of the project.
create	insert	project_id, target_spec		Allocates a floating IP in a region.
update	update	id, project_id, target_spec		Replaces the floating IP's target specification as a whole. The body carries the complete desired state of every field publicCloud.publicIp.FloatingIPUpdateTargetSpec exposes, which today is description alone. description is optional: restate it to keep it, and leave it out to clear it. This is how a description is removed. There is no separate delete.<br /><br />The create-only field location cannot be changed once the floating IP exists. It is deliberately absent from the update model, and sending it is rejected with a 400.<br /><br />The optional checksum guards against a lost update: when supplied it must match the floating IP's current checksum or the request is rejected with a 409 checksum mismatch. Omitting it skips the check and forces the write (last-write-wins).
delete	delete	id, project_id		Deletes the floating IP. If it's associated with a resource, it is disassociated automatically.

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"}})
id	string (ipv4)	Id
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns the floating IP, including the resource it's currently associated with.

SELECT
id,
checksum,
created_at,
current_state,
current_tasks,
resource_status,
target_spec,
updated_at
FROM ovh.public_cloud_network.public_ip_floatings
WHERE id = '{{ id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Returns the floating IPs of the project.

SELECT
id,
checksum,
created_at,
current_state,
current_tasks,
resource_status,
target_spec,
updated_at
FROM ovh.public_cloud_network.public_ip_floatings
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 }}'
;

INSERT examples

create

Allocates a floating IP in a region.

INSERT INTO ovh.public_cloud_network.public_ip_floatings (
target_spec,
project_id
)
SELECT 
'{{ target_spec }}' /* required */,
'{{ project_id }}'
RETURNING
id,
checksum,
created_at,
current_state,
current_tasks,
resource_status,
target_spec,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: public_ip_floatings
props:
  - name: project_id
    value: "{{ project_id }}"
    description: Required parameter for the public_ip_floatings resource.
  - name: target_spec
    description: |
      Desired target specification for the floating IP to create
    value:
      description: "{{ description }}"
      location:
        availabilityZone: "{{ availabilityZone }}"
        region: "{{ region }}"

UPDATE examples

update

Replaces the floating IP's target specification as a whole. The body carries the complete desired state of every field publicCloud.publicIp.FloatingIPUpdateTargetSpec exposes, which today is description alone. description is optional: restate it to keep it, and leave it out to clear it. This is how a description is removed. There is no separate delete.<br /><br />The create-only field location cannot be changed once the floating IP exists. It is deliberately absent from the update model, and sending it is rejected with a 400.<br /><br />The optional checksum guards against a lost update: when supplied it must match the floating IP's current checksum or the request is rejected with a 409 checksum mismatch. Omitting it skips the check and forces the write (last-write-wins).

UPDATE ovh.public_cloud_network.public_ip_floatings
SET 
checksum = '{{ checksum }}',
target_spec = '{{ target_spec }}'
WHERE 
id = '{{ id }}' --required
AND project_id = '{{ project_id }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
AND target_spec = '{{ target_spec }}' --required
RETURNING
id,
checksum,
created_at,
current_state,
current_tasks,
resource_status,
target_spec,
updated_at;

DELETE examples

delete

Deletes the floating IP. If it's associated with a resource, it is disassociated automatically.

DELETE FROM ovh.public_cloud_network.public_ip_floatings
WHERE id = '{{ id }}' --required
AND project_id = '{{ project_id }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;