summaryrefslogtreecommitdiff
path: root/api-ref/source/dns-api-v2-reverse-floatingips.inc
blob: 55dc18b51870332957381c00c9852af8ac5c1e6c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
===========
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.

Normal response codes: 202

Error response codes: 405,404,403,401,400,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

Normal response codes: 200

Error response codes: 405,404,403,401,400,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

Normal response codes: 200

Error response codes: 405,404,403,401,400,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

Normal response codes: 202

Error response codes: 405,404,403,401,400,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