public_ip_ext_nets

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

Overview

Name	public_ip_ext_nets
Type	Resource
Id	ovh.public_cloud_network.public_ip_ext_nets

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (ipv4)	The Ext-Net 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 Ext-Net IP (wire: createdAt)
current_state	object	Current state of the Ext-Net IP (wire: currentState)
current_tasks	array	Ongoing asynchronous tasks related to the Ext-Net IP (wire: currentTasks)
resource_status	string	Ext-Net 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 Ext-Net IP (wire: targetSpec)
updated_at	string (date-time)	Last update date of the Ext-Net IP (wire: updatedAt)

list

A Public Cloud Ext-Net public IP (keyed by IP address)

Name	Datatype	Description
id	string (ipv4)	The Ext-Net 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 Ext-Net IP (wire: createdAt)
current_state	object	Current state of the Ext-Net IP (wire: currentState)
current_tasks	array	Ongoing asynchronous tasks related to the Ext-Net IP (wire: currentTasks)
resource_status	string	Ext-Net 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 Ext-Net IP (wire: targetSpec)
updated_at	string (date-time)	Last update date of the Ext-Net 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 Ext-Net IP, including the resource it's associated with.
list	select	project_id	x_pagination_cursor, x_pagination_size	Returns the Ext-Net IPs of the project.
delete	delete	id, project_id		Deletes the Ext-Net 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 Ext-Net IP, including the resource it's associated with.

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

list

Returns the Ext-Net 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_ext_nets
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 }}'
;

DELETE examples

delete

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

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