← Back to branch summary

~ubuntu-branches/ubuntu/quantal/nova/quantal-proposed

« back to all changes in this revision

Viewing changes to doc/source/api_ext/ext_floating_ip_dns.rst

  • Committer: Package Import Robot
  • Author(s): Chuck Short
  • Date: 2012-01-20 11:54:15 UTC
  • mto: This revision was merged to the branch mainline in revision 62.
  • Revision ID: package-import@ubuntu.com-20120120115415-h2ujma9o536o1ut6
Tags: upstream-2012.1~e3~20120120.12170
Import upstream version 2012.1~e3~20120120.12170

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/api_ext/ext_floating_ip_dns.rst
85
85
 
86
86
New Resources
87
87
-------------
88
 
Get a list of DNS Domains (aka 'zones') published by the DNS driver:
 
88
Get a list of registered DNS Domains published by the DNS drivers:
89
89
 
90
90
        GET /v1.1/<tenant_id>/os-floating-ip-dns/
91
91
 
92
92
    # Sample Response:
93
 
    { 'zones' : [
94
 
      {'zone' : 'example.org'}
95
 
      {'zone' : 'example.net'}]}
96
 
 
97
 
 
98
 
Create a DNS entry:
99
 
 
100
 
        POST /v1.1/<tenant_id>/os-floating-ip-dns/
 
93
    {'domain_entries' : [
 
94
      {'domain': 'domain1.example.org', 'scope': 'public', 'project': 'proj1'}
 
95
      {'domain': 'domain2.example.net', 'scope': 'public', 'project': 'proj2'}
 
96
      {'domain': 'example.net', 'scope': 'public', 'project': ''}
 
97
      {'domain': 'example.internal', 'scope': 'private', 'availability_zone': 'zone1'}]}
 
98
 
 
99
 
 
100
Create or modify a DNS domain:
 
101
 
 
102
        PUT /v1.1/<tenant_id>/os-floating-ip-dns/<domain>
 
103
 
 
104
    # Sample body, public domain:
 
105
     {'domain_entry' :
 
106
       {'scope': 'public',
 
107
        'project' : 'project1'}}
 
108
 
 
109
    # Sample body, public (projectless) domain:
 
110
     {'domain_entry' :
 
111
       {'scope': 'public'}}
 
112
 
 
113
    # Sample Response, public domain (success):
 
114
     {'domain_entry' :
 
115
       {'domain': 'domain1.example.org',
 
116
        'scope': 'public',
 
117
        'project': 'project1'}}
 
118
 
 
119
    # Sample body, private domain:
 
120
     {'domain_entry' :
 
121
       {'scope': 'private',
 
122
        'availability_domain': 'zone1'}}
 
123
 
 
124
    # Sample Response, private domain (success):
 
125
     {'domain_entry' :
 
126
       {'domain': 'domain1.private',
 
127
        'scope': 'private',
 
128
        'availability_zone': 'zone1'}}
 
129
 
 
130
    Failure Response Code: 403 (Insufficient permissions.)
 
131
 
 
132
 
 
133
Delete a DNS domain and all associated host entries:
 
134
 
 
135
DELETE /v1.1/<tenant_id>/os-floating-ip-dns/<domain>
 
136
 
 
137
    Normal Response Code: 200
 
138
    Failure Response Code: 404 (Domain to be deleted not found.)
 
139
    Failure Response Code: 403 (Insufficient permissions to delete.)
 
140
 
 
141
 
 
142
Create or modify a DNS entry:
 
143
 
 
144
        PUT /v1.1/<tenant_id>/os-floating-ip-dns/<domain>/entries/<name>
101
145
 
102
146
    # Sample body:
103
147
    { 'dns_entry' :
104
 
      { 'name': 'instance1',
105
 
        'ip': '192.168.53.11',
106
 
        'dns_type': 'A',
107
 
        'zone': 'example.org'}}
 
148
      { 'ip': '192.168.53.11',
 
149
        'dns_type': 'A' }}
108
150
 
109
151
    # Sample Response (success):
110
152
    { 'dns_entry' :
111
 
      { 'ip' : '192.168.53.11',
112
 
        'type' : 'A',
113
 
        'zone' : 'example.org',
 
153
      { 'type' : 'A',
114
154
        'name' : 'instance1' }}
115
155
 
116
 
    Failure Response Code: 409 (indicates an entry with name & zone already exists.)
117
 
 
118
 
 
119
 
Change the ip address of an existing DNS entry:
120
 
 
121
 
        PUT /v1.1/<tenant_id>/os-floating-ip-dns/<domain>
122
 
 
123
 
    # Sample body:
124
 
    { 'dns_entry' :
125
 
      { 'name': 'instance1',
126
 
        'ip': '192.168.53.99'}}
127
 
 
128
 
    # Sample Response (success):
129
 
    { 'dns_entry' :
130
 
      { 'ip' : '192.168.53.99',
131
 
        'name' : 'instance1',
132
 
        'zone' : 'example.org'}}
133
 
 
134
 
    Failure Response Code: 404 (Entry to be modified not found)
135
 
 
136
 
 
137
 
Find DNS entries for a given domain and name:
138
 
 
139
 
        GET /v1.1/<tenant_id>/os-floating-ip-dns/<domain>?name=<name>
 
156
 
 
157
Find unique DNS entry for a given domain and name:
 
158
 
 
159
        GET /v1.1/<tenant_id>/os-floating-ip-dns/<domain>/entries/<name>
140
160
 
141
161
    # Sample Response:
142
 
    { 'dns_entries' : [
 
162
    { 'dns_entry' :
143
163
      { 'ip' : '192.168.53.11',
144
164
        'type' : 'A',
145
 
        'zone' : <domain>,
146
 
        'name' : <name> }]}
 
165
        'domain' : <domain>,
 
166
        'name' : <name> }}
147
167
 
148
168
 
149
169
Find DNS entries for a given domain and ip:
150
170
 
151
 
        GET /v1.1/<tenant_id>/os-floating-ip-dns/<domain>/?ip=<ip>
 
171
        GET /v1.1/<tenant_id>/os-floating-ip-dns/<domain>/entries?ip=<ip>
152
172
 
153
173
    # Sample Response:
154
174
    { 'dns_entries' : [
155
175
      { 'ip' : <ip>,
156
176
        'type' : 'A',
157
 
        'zone' : <domain>,
 
177
        'domain' : <domain>,
158
178
        'name' : 'example1' }
159
179
      { 'ip' : <ip>,
160
180
        'type' : 'A',
161
 
        'zone' : <domain>,
 
181
        'domain' : <domain>,
162
182
        'name' : 'example2' }]}
163
183
 
164
184
 
165
185
Delete a DNS entry:
166
186
 
167
 
DELETE /v1.1/<tenant_id>/os-floating-ip-dns/<domain>?name=<name>
 
187
DELETE /v1.1/<tenant_id>/os-floating-ip-dns/<domain>/entries/<name>
168
188
 
169
189
    Normal Response Code: 200
170
190
    Failure Response Code: 404 (Entry to be deleted not found)
171
191
 
 
192
 
172
193
New States
173
194
----------
174
195
None
176
197
Changes to the Cloud Servers Specification
177
198
------------------------------------------
178
199
None
179