Add docs for SSHFP, SRV, SPF and MX recordsets to api-ref
Change-Id: I758271cbebc012f1fa15f552227e6e73aac49635
This commit is contained in:
sonu.kumar
parent
812780d45b
commit
8ce138dac1
|
|
@ -362,3 +362,262 @@ Response Example
|
|||
.. literalinclude:: samples/recordsets/update-recordset-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
Create a MX Recordset
|
||||
=====================
|
||||
|
||||
.. rest_method:: POST /v2/zones/{zone_id}/recordsets
|
||||
|
||||
Create a MX recordset in a zone
|
||||
|
||||
|
||||
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
|
||||
- zone_id: path_zone_id
|
||||
- name: recordset_name
|
||||
- ttl: recordset_ttl
|
||||
- description: recordset_description
|
||||
- type: recordset_type
|
||||
- records: recordset_records
|
||||
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: samples/recordsets/create-mx-recordset-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- x-openstack-request-id: x-openstack-request-id
|
||||
- id: id
|
||||
- project_id: project_id
|
||||
- name: recordset_name
|
||||
- ttl: recordset_ttl
|
||||
- status: status
|
||||
- action: action
|
||||
- zone_id: recordset_zone_id
|
||||
- zone_name: recordset_zone_name
|
||||
- description: recordset_description
|
||||
- type: recordset_type
|
||||
- version: version
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- links: links
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: samples/recordsets/create-mx-recordset-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
Create a SSHFP Recordset
|
||||
========================
|
||||
|
||||
.. rest_method:: POST /v2/zones/{zone_id}/recordsets
|
||||
|
||||
Create a MX recordset in a zone
|
||||
|
||||
|
||||
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
|
||||
- zone_id: path_zone_id
|
||||
- name: recordset_name
|
||||
- ttl: recordset_ttl
|
||||
- description: recordset_description
|
||||
- type: recordset_type
|
||||
- records: recordset_records
|
||||
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: samples/recordsets/create-sshfp-recordset-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- x-openstack-request-id: x-openstack-request-id
|
||||
- id: id
|
||||
- project_id: project_id
|
||||
- name: recordset_name
|
||||
- ttl: recordset_ttl
|
||||
- status: status
|
||||
- action: action
|
||||
- zone_id: recordset_zone_id
|
||||
- zone_name: recordset_zone_name
|
||||
- description: recordset_description
|
||||
- type: recordset_type
|
||||
- version: version
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- links: links
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: samples/recordsets/create-sshfp-recordset-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
Create a SPF Recordset
|
||||
======================
|
||||
|
||||
.. rest_method:: POST /v2/zones/{zone_id}/recordsets
|
||||
|
||||
Create a MX recordset in a zone
|
||||
|
||||
|
||||
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
|
||||
- zone_id: path_zone_id
|
||||
- name: recordset_name
|
||||
- ttl: recordset_ttl
|
||||
- description: recordset_description
|
||||
- type: recordset_type
|
||||
- records: recordset_records
|
||||
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: samples/recordsets/create-spf-recordset-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- x-openstack-request-id: x-openstack-request-id
|
||||
- id: id
|
||||
- project_id: project_id
|
||||
- name: recordset_name
|
||||
- ttl: recordset_ttl
|
||||
- status: status
|
||||
- action: action
|
||||
- zone_id: recordset_zone_id
|
||||
- zone_name: recordset_zone_name
|
||||
- description: recordset_description
|
||||
- type: recordset_type
|
||||
- version: version
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- links: links
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: samples/recordsets/create-spf-recordset-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
Create a SRV Recordset
|
||||
======================
|
||||
|
||||
.. rest_method:: POST /v2/zones/{zone_id}/recordsets
|
||||
|
||||
Create a MX recordset in a zone
|
||||
|
||||
|
||||
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
|
||||
- zone_id: path_zone_id
|
||||
- name: recordset_name
|
||||
- ttl: recordset_ttl
|
||||
- description: recordset_description
|
||||
- type: recordset_type
|
||||
- records: recordset_records
|
||||
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: samples/recordsets/create-srv-recordset-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- x-openstack-request-id: x-openstack-request-id
|
||||
- id: id
|
||||
- project_id: project_id
|
||||
- name: recordset_name
|
||||
- ttl: recordset_ttl
|
||||
- status: status
|
||||
- action: action
|
||||
- zone_id: recordset_zone_id
|
||||
- zone_name: recordset_zone_name
|
||||
- description: recordset_description
|
||||
- type: recordset_type
|
||||
- version: version
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- links: links
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: samples/recordsets/create-srv-recordset-response.json
|
||||
:language: javascript
|
||||
|
|
|
|||
|
|
@ -0,0 +1,12 @@
|
|||
{
|
||||
"name" : "mail.example.org.",
|
||||
"description" : "An MX recordset.",
|
||||
"type" : "MX",
|
||||
"ttl" : 3600,
|
||||
"records" : [
|
||||
"10 mail1.example.org.",
|
||||
"20 mail2.example.org.",
|
||||
"30 mail3.example.org.",
|
||||
"40 mail4.example.org."
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
{
|
||||
"status": "PENDING",
|
||||
"description": "An MX recordset.",
|
||||
"links": {
|
||||
"self": "http://127.0.0.1:9001/v2/zones/f6b472ed-1be8-47e8-87a7-687169cacca8/recordsets/c3c1f506-adcf-4751-ae5b-1c5ff00d2e1a"
|
||||
},
|
||||
"created_at": "2016-06-21 06:34:36",
|
||||
"updated_at": null,
|
||||
"records": [
|
||||
"10 mail1.example.org.",
|
||||
"30 mail3.example.org.",
|
||||
"20 mail2.example.org.",
|
||||
"40 mail4.example.org."
|
||||
],
|
||||
"zone_id": "f6b472ed-1be8-47e8-87a7-687169cacca8",
|
||||
"version": 1,
|
||||
"ttl": 3600,
|
||||
"action": "CREATE",
|
||||
"zone_name": "example.org.",
|
||||
"type": "MX",
|
||||
"id": "c3c1f506-adcf-4751-ae5b-1c5ff00d2e1a",
|
||||
"name": "mail.example.org."
|
||||
}
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
{
|
||||
"name" : "foospf.example.org.",
|
||||
"description" : "An SPF recordset.",
|
||||
"type" : "SPF",
|
||||
"ttl" : 3600,
|
||||
"records" : [
|
||||
"v=spf1 +all"
|
||||
]
|
||||
}
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
{
|
||||
"status": "PENDING",
|
||||
"description": "An SPF recordset.",
|
||||
"links": {
|
||||
"self": "http://127.0.0.1:9001/v2/zones/f6b472ed-1be8-47e8-87a7-687169cacca8/recordsets/c05a6740-2602-4439-bb70-187dd6547c13"
|
||||
},
|
||||
"created_at": "2016-06-21 12:31:44",
|
||||
"updated_at": null,
|
||||
"records": [
|
||||
"v=spf1 +all"
|
||||
],
|
||||
"zone_id": "f6b472ed-1be8-47e8-87a7-687169cacca8",
|
||||
"version": 1,
|
||||
"ttl": 3600,
|
||||
"action": "CREATE",
|
||||
"zone_name": "example.org.",
|
||||
"type": "SPF",
|
||||
"id": "c05a6740-2602-4439-bb70-187dd6547c13",
|
||||
"name": "foospf.example.org."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"name" : "_http._tcp.example.org.",
|
||||
"description" : "An SRV recordset.",
|
||||
"type" : "SRV",
|
||||
"ttl" : 3600,
|
||||
"records" : [
|
||||
"10 0 5060 www.example.org."
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
{
|
||||
"status": "PENDING",
|
||||
"description": "An SRV recordset.",
|
||||
"links": {
|
||||
"self": "http://127.0.0.1:9001/v2/zones/f6b472ed-1be8-47e8-87a7-687169cacca8/recordsets/cc3299b3-c3cd-47e5-9876-8c1d4ad1b88e"
|
||||
},
|
||||
"created_at": "2016-06-21 12:44:38",
|
||||
"updated_at": null,
|
||||
"records": [
|
||||
"10 0 5060 www.example.org."
|
||||
],
|
||||
"zone_id": "f6b472ed-1be8-47e8-87a7-687169cacca8",
|
||||
"version": 1,
|
||||
"ttl": 3600,
|
||||
"action": "CREATE",
|
||||
"zone_name": "example.org.",
|
||||
"type": "SRV",
|
||||
"id": "cc3299b3-c3cd-47e5-9876-8c1d4ad1b88e",
|
||||
"name": "_http._tcp.example.org."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"name" : "foo.example.org.",
|
||||
"description" : "An SSHFP recordset.",
|
||||
"type" : "SSHFP",
|
||||
"ttl" : 3600,
|
||||
"records" : [
|
||||
"1 2 6467a09c59607b01fef22ef6918c44a2eaaa14a5e055cfe91bf614b5796d2df0"
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
{
|
||||
"status": "ACTIVE",
|
||||
"description": null,
|
||||
"links": {
|
||||
"self": "http://127.0.0.1:9001/v2/zones/f6b472ed-1be8-47e8-87a7-687169cacca8/recordsets/5fb9d67c-86ac-4ae9-80d5-4c23f7a16b29"
|
||||
},
|
||||
"created_at": "2016-06-21 12:15:35",
|
||||
"updated_at": null,
|
||||
"records": [
|
||||
"2 1 75e080122854693164599205f49d7475ed17d09b"
|
||||
],
|
||||
"zone_id": "f6b472ed-1be8-47e8-87a7-687169cacca8",
|
||||
"version": 1,
|
||||
"ttl": 3600,
|
||||
"action": "NONE",
|
||||
"zone_name": "example.org.",
|
||||
"type": "SSHFP",
|
||||
"id": "5fb9d67c-86ac-4ae9-80d5-4c23f7a16b29",
|
||||
"name": "foo.example.org."
|
||||
}
|
||||
Loading…
Reference in New Issue