6987a1f506
Verified the API document with source for methods available and response codes used. Part of bp:api-ref-in-rst Change-Id: Ic462bbdd1f559a89aa43707cf510b6cf621ff4b0
209 lines
4.4 KiB
ReStructuredText
209 lines
4.4 KiB
ReStructuredText
.. -*- rst -*-
|
|
.. needs:parameter_verification
|
|
.. needs:example_verification
|
|
.. needs:body_verification
|
|
|
|
==============================================
|
|
Floating IP DNS records (os-floating-ip-dns)
|
|
==============================================
|
|
|
|
Manages DNS records associated with floating IP addresses. The API
|
|
dispatches requests to a DNS driver that is selected at startup.
|
|
|
|
List Dns Domains
|
|
================
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/os-floating-ip-dns
|
|
|
|
Lists registered DNS domains published by the DNS drivers.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), notImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example List Dns Domains: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-list-resp.json
|
|
:language: javascript
|
|
|
|
Create Or Update Dns Domain
|
|
===========================
|
|
|
|
.. rest_method:: PUT /v2.1/{tenant_id}/os-floating-ip-dns/{domain}
|
|
|
|
Creates or updates a DNS domain.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: badRequest(400), unauthorized(401),
|
|
forbidden(403), notImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- domain: domain
|
|
|
|
**Example Create Or Update Dns Domain: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Create Or Update Dns Domain: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-resp.json
|
|
:language: javascript
|
|
|
|
Delete Dns Domain
|
|
=================
|
|
|
|
.. rest_method:: DELETE /v2.1/{tenant_id}/os-floating-ip-dns/{domain}
|
|
|
|
Deletes a DNS domain and all associated host entries.
|
|
|
|
Normal response codes: 202
|
|
|
|
Error response codes: unauthorized(401), forbidden(403),
|
|
itemNotFound(404), notImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- domain: domain
|
|
|
|
Response
|
|
--------
|
|
|
|
List Dns Entries
|
|
================
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/os-floating-ip-dns/{domain}/entries/{ip}
|
|
|
|
Lists DNS entries for a domain and IP.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403),
|
|
itemNotFound(404), notImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- domain: domain
|
|
- ip: ip
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example List Dns Entries: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-entry-list-resp.json
|
|
:language: javascript
|
|
|
|
Find Unique Dns Entry
|
|
=====================
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/os-floating-ip-dns/{domain}/entries/{name}
|
|
|
|
Finds a unique DNS entry for a domain and name.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403),
|
|
itemNotFound(404), notImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- domain: domain
|
|
- name: name
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Find Unique Dns Entry: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-entry-get-resp.json
|
|
:language: javascript
|
|
|
|
Create Or Update Dns Entry
|
|
==========================
|
|
|
|
.. rest_method:: PUT /v2.1/{tenant_id}/os-floating-ip-dns/{domain}/entries/{name}
|
|
|
|
Creates or updates a DNS entry.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), notImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- domain: domain
|
|
- name: name
|
|
|
|
**Example Create Or Update Dns Entry: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-entry-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Create Or Update Dns Entry: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-entry-resp.json
|
|
:language: javascript
|
|
|
|
Delete Dns Entry
|
|
================
|
|
|
|
.. rest_method:: DELETE /v2.1/{tenant_id}/os-floating-ip-dns/{domain}/entries/{name}
|
|
|
|
Deletes a DNS entry.
|
|
|
|
Normal response codes: 202
|
|
|
|
Error response codes: unauthorized(401), forbidden(403),
|
|
itemNotFound(404), notImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- domain: domain
|
|
- name: name
|
|
|
|
Response
|
|
--------
|