234 lines
4.2 KiB
PHP
234 lines
4.2 KiB
PHP
===========
|
|
FloatingIPs
|
|
===========
|
|
|
|
In order to use the FloatingIPs functionality you will need to have a FloatingIP
|
|
associated to your project in Neutron.
|
|
|
|
Set FloatingIP's PTR record
|
|
============================
|
|
|
|
.. rest_method:: PATCH /v2/reverse/floatingips/{region}:{floatingip_id}
|
|
|
|
Set a PTR record for the given FloatingIP. The domain if it does not exist
|
|
will be provisioned automatically.
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 202
|
|
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 404
|
|
- 405
|
|
- 409
|
|
- 503
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- x-auth-token: x-auth-token
|
|
- x-auth-all-projects: x-auth-all-projects
|
|
- x-auth-sudo-project-id: x-auth-sudo-project-id
|
|
- ptrdname: fptrd_name
|
|
- description: fptr_description
|
|
- ttl: fptr_ttl
|
|
- region: region
|
|
- floatingip_id: floatingip_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/reverse_floatingips/set-ptr-record-request.json
|
|
:language: javascript
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- x-openstack-request-id: x-openstack-request-id
|
|
- id: fptr_id
|
|
- ptrdname: fptrd_name
|
|
- description: fptr_description
|
|
- ttl: fptr_ttl
|
|
- address: floatingip_address
|
|
- status: status
|
|
- action: action
|
|
- links: links
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/reverse_floatingips/ptr-record-response.json
|
|
:language: javascript
|
|
|
|
|
|
Show FloatingIP's PTR record
|
|
============================
|
|
|
|
.. rest_method:: GET /v2/reverse/floatingips/{region}:{floatingip_id}
|
|
|
|
Shows a particular FloatingIP PTR
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 404
|
|
- 405
|
|
- 503
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- x-auth-token: x-auth-token
|
|
- x-auth-all-projects: x-auth-all-projects
|
|
- x-auth-sudo-project-id: x-auth-sudo-project-id
|
|
- region: region
|
|
- floatingip_id: floatingip_id
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- x-openstack-request-id: x-openstack-request-id
|
|
- id: fptr_id
|
|
- ptrdname: fptrd_name
|
|
- description: fptr_description
|
|
- ttl: fptr_ttl
|
|
- address: floatingip_address
|
|
- status: status
|
|
- action: action
|
|
- links: links
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/reverse_floatingips/ptr-record-response.json
|
|
:language: javascript
|
|
|
|
|
|
List FloatingIP's PTR record
|
|
============================
|
|
|
|
.. rest_method:: GET /v2/reverse/floatingips
|
|
|
|
List FloatingIP PTR records
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 404
|
|
- 405
|
|
- 503
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- x-auth-token: x-auth-token
|
|
- x-auth-all-projects: x-auth-all-projects
|
|
- x-auth-sudo-project-id: x-auth-sudo-project-id
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- x-openstack-request-id: x-openstack-request-id
|
|
- id: fptr_id
|
|
- ptrdname: fptrd_name
|
|
- description: fptr_description
|
|
- ttl: fptr_ttl
|
|
- address: floatingip_address
|
|
- status: status
|
|
- action: action
|
|
- links: links
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/reverse_floatingips/list-ptr-record-response.json
|
|
:language: javascript
|
|
|
|
|
|
Unset FloatingIP's PTR record
|
|
=============================
|
|
|
|
.. rest_method:: PATCH /v2/reverse/floatingips/{region}:{floatingip_id}
|
|
|
|
Unset the PTR record for a FloatingIP
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 202
|
|
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 404
|
|
- 405
|
|
- 503
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- x-auth-token: x-auth-token
|
|
- x-auth-all-projects: x-auth-all-projects
|
|
- x-auth-sudo-project-id: x-auth-sudo-project-id
|
|
- region: region
|
|
- floatingip_id: floatingip_id
|
|
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/reverse_floatingips/unset-ptr-record-request.json
|
|
:language: javascript
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- x-openstack-request-id: x-openstack-request-id
|