summaryrefslogtreecommitdiff
path: root/api-ref/source/dns-api-v2-pool.inc
blob: 3d0ee9e252702b66af08aae84a949b2e24f7c8ac (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
=====
Pools
=====

Get information about the pools in a designate install


List all Pools
==============

.. rest_method::  GET /v2/pools

Get the list of Pools.


.. 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
   - description: description
   - id: pool_id
   - attributes: pool_attributes
   - project_id: project_id
   - ns_records: pool_ns_records
   - name: pool_name
   - created_at: created_at
   - updated_at: updated_at
   - links: links
   - metadata: metadata



Response Example
----------------

.. literalinclude:: samples/pools/list-pools-response.json
   :language: javascript


Show a Pool
===========

.. rest_method::  GET /v2/pools/{pool_id}

Get a specific Pool


Normal response codes: 200

Error response codes: 405,404,403,401,400,503


.. 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
   - pool_id: path_pool_id


Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - x-openstack-request-id: x-openstack-request-id
   - description: description
   - id: pool_id
   - attributes: pool_attributes
   - project_id: project_id
   - ns_records: pool_ns_records
   - name: pool_name
   - created_at: created_at
   - updated_at: updated_at
   - links: links
   - metadata: metadata



Response Example
----------------

.. literalinclude:: samples/pools/show-pool-response.json
   :language: javascript