Jump to: navigation, search

Difference between revisions of "Designate/Blueprints/ReverseFixedIP"

(→‎List the Fixed IP PTR Records (GET))
 
(54 intermediate revisions by the same user not shown)
Line 10: Line 10:
 
=== Summary ===
 
=== Summary ===
  
−
Quick overview of the change
+
This blueprint proposes to provide an interface for a VM instance's PTR record based on the allocated Fixed IP.
  
−
== API Changes ==
+
This blueprint is based on the blueprint for floating IP PTR records:
  
−
List of changes to the HTTP API
+
    [[Designate/Blueprints/Reverse]]
  
−
=== One Per Change ===
+
== API Resource - Private / Fixed IPs ==
 +
 
 +
Using the general endpoint call "/reverse" add the fixed IP resource called "fixedips".
 +
 
 +
=== API Details ===
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
 
! Verb !! Resource !! Description
 
! Verb !! Resource !! Description
 
|-
 
|-
−
| GET || /resource || Description of call
+
| GET || /reverse/fixedips || Return the list of PTR records for all fixed IP addresses.
 
|-
 
|-
−
| GET || /resource/{id} || Description of call
+
| GET || /reverse/fixedips/{region}:{IP address} || Return the PTR record for the given fixed IP address.
 +
|-
 +
| PATCH || /reverse/fixedips/{region}:{IP address} || Create or delete the PTR record for the given fixed IP address.
 
|}
 
|}
  
−
==== Example of Call (HTTP Verb) ====
+
==== List the Fixed IP PTR Records (GET) ====
  
−
Overview of call
+
Return the list of PTR record for all fixed IP addresses.
 +
 
 +
There is no request message body.
  
 
'''Response'''
 
'''Response'''
 
     {
 
     {
−
         “data”: [
+
         “fixedips”: [
 +
            {
 +
                "ptrdname": "server.mydomain.com.",
 +
                "address": "<region>:<ipv4 or ipv6 compliant address>",
 +
                "ttl": 3600,
 +
                "description": null,
 +
                "links": {
 +
                    "self": "http://endpoint/v2/reverse/fixedips/<region>:<ipv4 or ipv6 compliant address>"
 +
                }
 +
            },
 
             {
 
             {
−
                 "more":"data"
+
                 "ptrdname": "server2.mydomain.com.",
 +
                "address": "<region>:<ipv4 or ipv6 compliant address>",
 +
                "ttl": 3600,
 +
                "description": null,
 +
                "links": {
 +
                    "self": "http://endpoint/v2/reverse/fixedips/<region>:<ipv4 or ipv6 compliant address>"
 +
                }
 +
            }
 +
        ],
 +
        "links": {
 +
            "self": "http://endpoint/v2/reverse/fixedips"
 +
        }
 +
    }
 +
 
 +
==== Get the Fixed IP PTR Record (GET) ====
 +
 
 +
Return the PTR record for the given fixed IP address.
 +
 
 +
There is no request message body.
 +
 
 +
'''Response'''
 +
    {
 +
        “fixedip”: {
 +
            "ptrdname": "server.mydomain.com.",
 +
            "address": "<region>:<ipv4 or ipv6 compliant address>",
 +
            "ttl": 3600,
 +
            "description": null,
 +
            "links": {
 +
                "self": "http://endpoint/v2/reverse/fixedips/<region>:<ipv4 or ipv6 compliant address>"
 +
            }
 +
        }
 +
    }
 +
 
 +
==== Create the Fixed IP PTR Record (PATCH) ====
 +
 
 +
Create the PTR record for the given fixed IP address.
 +
 
 +
'''Request'''
 +
    {
 +
        "fixedip": {
 +
            "ptrdname": "server.mydomain.com.",
 +
            "ttl": 3600
 +
        }
 +
    }
 +
 
 +
'''Response'''
 +
    {
 +
        “fixedip”: {
 +
            "ptrdname": "server.mydomain.com.",
 +
            "address": "<region>:<ipv4 or ipv6 compliant address>",
 +
            "ttl": 3600,
 +
            "description": null,
 +
            "links": {
 +
                "self": "http://endpoint/v2/reverse/fixedips/<region>:<ipv4 or ipv6 compliant address>"
 
             }
 
             }
−
          ]
+
        }
 
     }
 
     }
  
−
== Database Changes ==
+
==== Delete the Fixed IP PTR Record (PATCH) ====
−
Description of Changes to DB schemas
+
 
 +
Delete the PTR record for the given fixed IP address.
 +
 
 +
'''Request'''
 +
    {
 +
        "fixedip": {
 +
            "ptrdname": null
 +
        }
 +
    }
  
−
eg -
+
The return body is empty.
  
−
{| class="wikitable"
+
== Database Changes ==
−
|-
+
There are no changes to the database schema.
−
! Name!! Data Type !! Length !! Nullable!! Details
 
−
|-
 
−
| id || VARCHAR || 36 || False || Primary Key, Generated UUID
 
−
|-
 
−
| name || VARCHAR || 255 || False || Domain name to be blacklisted
 
−
|-
 
−
| version || INTEGER || - || False || Designate API version
 
−
|-
 
−
| created_at || DATETIME ||  -  || False || UTC time of creation
 
−
|-
 
−
| updated_at || DATETIME || - ||True || UTC time of creation
 
−
|-
 
−
| description || VARCHAR || 160 || True || UTF-8 text field
 
−
|}
 

Latest revision as of 15:28, 13 March 2014

Overview

Gerrit Patch []
Launchpad Blueprint [1]

Summary

This blueprint proposes to provide an interface for a VM instance's PTR record based on the allocated Fixed IP.

This blueprint is based on the blueprint for floating IP PTR records: 

   Designate/Blueprints/Reverse

API Resource - Private / Fixed IPs

Using the general endpoint call "/reverse" add the fixed IP resource called "fixedips".

API Details

Verb Resource Description
GET /reverse/fixedips Return the list of PTR records for all fixed IP addresses.
GET /reverse/fixedips/{region}:{IP address} Return the PTR record for the given fixed IP address.
PATCH /reverse/fixedips/{region}:{IP address} Create or delete the PTR record for the given fixed IP address.

List the Fixed IP PTR Records (GET)

Return the list of PTR record for all fixed IP addresses.

There is no request message body.

Response 

   {
       “fixedips”: [
           {
               "ptrdname": "server.mydomain.com.",
               "address": "<region>:<ipv4 or ipv6 compliant address>",
               "ttl": 3600,
               "description": null,
               "links": {
                   "self": "http://endpoint/v2/reverse/fixedips/<region>:<ipv4 or ipv6 compliant address>"
               }
           },
           {
               "ptrdname": "server2.mydomain.com.",
               "address": "<region>:<ipv4 or ipv6 compliant address>",
               "ttl": 3600,
               "description": null,
               "links": {
                   "self": "http://endpoint/v2/reverse/fixedips/<region>:<ipv4 or ipv6 compliant address>"
               }
           }
       ],
       "links": {
           "self": "http://endpoint/v2/reverse/fixedips"
       }
   }

Get the Fixed IP PTR Record (GET)

Return the PTR record for the given fixed IP address.

There is no request message body.

Response 

   {
       “fixedip”: {
           "ptrdname": "server.mydomain.com.",
           "address": "<region>:<ipv4 or ipv6 compliant address>",
           "ttl": 3600,
           "description": null,
           "links": {
               "self": "http://endpoint/v2/reverse/fixedips/<region>:<ipv4 or ipv6 compliant address>"
           }
       }
   }

Create the Fixed IP PTR Record (PATCH)

Create the PTR record for the given fixed IP address.

Request 

   {
       "fixedip": {
           "ptrdname": "server.mydomain.com.",
           "ttl": 3600
       }
   }

Response 

   {
       “fixedip”: {
           "ptrdname": "server.mydomain.com.",
           "address": "<region>:<ipv4 or ipv6 compliant address>",
           "ttl": 3600,
           "description": null,
           "links": {
               "self": "http://endpoint/v2/reverse/fixedips/<region>:<ipv4 or ipv6 compliant address>"
           }
       }
   }

Delete the Fixed IP PTR Record (PATCH)

Delete the PTR record for the given fixed IP address.

Request 

   {
       "fixedip": {
           "ptrdname": null
       }
   }

The return body is empty.

Database Changes

There are no changes to the database schema.

Retrieved from "https://wiki.openstack.org/w/index.php?title=Designate/Blueprints/ReverseFixedIP&oldid=45474"