designate/api-ref/source/dns-api-v2-pool.inc
sonu.kumar 96bff5ce77 Improve response codes display in api-ref docs
Change-Id: I9fc35783dfd2732be03b10ab67ddd9c6b8137ad4
2016-05-20 11:34:28 +09:00

105 lines
1.8 KiB
PHP

=====
Pools
=====
Get information about the pools in a designate install
List all Pools
==============
.. rest_method:: GET /v2/pools
Get the list of Pools.
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
- 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
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