openstack/api-site
Code Issues Proposed changes

Merge "Revise clustering service API"

Browse Source
This commit is contained in:
Jenkins
2016-01-19 17:54:32 +00:00
committed by Gerrit Code Review
parent 3da50c20cc 6b3c67ad61
commit 093c8e380e
39 changed files with 580 additions and 643 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
api-ref/src/docbkx/api-ref-clustering-v1.xml
View File

@@ -6,9 +6,9 @@
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-clustering" status="CURRENT">
<info xreflabel="api-ref-clustering.html">
<title>OpenStack Clustering API v1</title>
xml:id="api.openstack.org-clustering-v1" status="CURRENT">
<info xreflabel="api-ref-clustering-v1.html">
<title>OpenStack Clustering API v1 (CURRENT)</title>
<copyright>
<year>2015</year>
</copyright>

5
api-ref/src/docbkx/ch_clustering-v1.xml
View File

@@ -103,7 +103,7 @@
<title>Nodes</title>
<para>
Lists all nodes, and creates, shows information for, updates,
deletes, and triggers an action on a node.
deletes a node.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/wadl/clustering-api.wadl#nodes">
@@ -115,9 +115,6 @@
<wadl:method href="#updateNode"/>
<wadl:method href="#deleteNode"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/wadl/clustering-api.wadl#node_actions">
<wadl:method href="#node_action"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="policies">

17
api-ref/src/wadls/clustering-api/src/v1/common.ent
View File

@@ -1,3 +1,20 @@
<!ENTITY global_projectRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="global_project" style="query" type="xsd:boolean" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Indicates whether to include objects for all projects or objects
for the current project in the response.
</para>
<para>
If you are an administrative user and you set this value to
<code>True</code>, the call returns all objects from all projects.
Default is <code>False</code>, which returns only objects in the
current project.
</para>
</wadl:doc>
</param>'>
<!ENTITY resourceLocationParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="location" style="header" type="xsd:string" required="true">

5
api-ref/src/wadls/clustering-api/src/v1/samples/action-show-response.json
View File

@@ -2,7 +2,7 @@
"action": "CLUSTER_DELETE",
"cause": "RPC Request",
"context": {},
"deleted_time": null,
"created_at": "2015-06-27T05:09:43",
"depended_by": [],
"depends_on": [],
"end_time": 1423570000.0,
@@ -16,5 +16,6 @@
"status": "FAILED",
"status_reason": "Cluster action FAILED",
"target": "fcc9b635-52e3-490b-99f2-87b1640e4e89",
"timeout": 3600
"timeout": 3600,
"updated_at": null
}

10
api-ref/src/wadls/clustering-api/src/v1/samples/actions-list-response.json
View File

@@ -3,7 +3,7 @@
{
"action": "NODE_CREATE",
"cause": "RPC Request",
"deleted_time": null,
"created_at": "2015-12-04T04:54:41",
"depended_by": [],
"depends_on": [],
"end_time": 1425550000.0,
@@ -17,12 +17,13 @@
"status": "SUCCEEDED",
"status_reason": "Action completed successfully.",
"target": "0df0931b-e251-4f2e-8719-4ebfda3627ba",
"timeout": 3600
"timeout": 3600,
"updated_at": null
},
{
"action": "NODE_DELETE",
"cause": "RPC Request",
"deleted_time": null,
"created_at": "2015-11-04T05:21:41",
"depended_by": [],
"depends_on": [],
"end_time": 1425550000.0,
@@ -36,7 +37,8 @@
"status": "SUCCEEDED",
"status_reason": "Action completed successfully.",
"target": "f0de9b9c-6d48-4a46-af21-2ca8607777fe",
"timeout": 3600
"timeout": 3600,
"updated_at": null
}
]
}

7
api-ref/src/wadls/clustering-api/src/v1/samples/cluster-create-response.json
View File

@@ -1,13 +1,12 @@
{
"cluster": {
"action": "bbf4558b-9fa3-482a-93c2-a4aa5cc85317",
"created_time": null,
"created_at": null,
"data": {},
"deleted_time": null,
"desired_capacity": 4,
"domain": null,
"id": "45edadcb-c73b-4920-87e1-518b2f29f54b",
"init_time": "2015-02-10T14:16:10",
"init_at": "2015-02-10T14:16:10",
"max_size": -1,
"metadata": {},
"min_size": 0,
@@ -21,7 +20,7 @@
"status": "INIT",
"status_reason": "Initializing",
"timeout": 3600,
"updated_time": null,
"updated_at": null,
"user": "5e5bf8027826429c96af157f68dc9072"
}
}

10
api-ref/src/wadls/clustering-api/src/v1/samples/cluster-policies-list-response.json
View File

@@ -3,26 +3,20 @@
{
"cluster_id": "7d85f602-a948-4a30-afd4-e84f47471c15",
"cluster_name": "cluster4",
"cooldown": 0,
"enabled": true,
"id": "06be3a1f-b238-4a96-a737-ceec5714087e",
"level": 0,
"policy_id": "714fe676-a08f-4196-b7af-61d52eeded15",
"policy_name": "dp01",
"policy_type": "DeletionPolicy",
"priority": 50
"policy_type": "senlin.policy.deletion-1.0"
},
{
"cluster_id": "7d85f602-a948-4a30-afd4-e84f47471c15",
"cluster_name": "cluster4",
"cooldown": 0,
"enabled": true,
"id": "abddc45e-ac31-4f90-93cc-db55a7d8dd6d",
"level": 30,
"policy_id": "e026e09f-a3e9-4dad-a1b9-d7ba316026a1",
"policy_name": "sp1",
"policy_type": "ScalingPolicy",
"priority": 30
"policy_type": "senlin.policy.scaling-1.0"
}
]
}

5
api-ref/src/wadls/clustering-api/src/v1/samples/cluster-policy-attach-request.json
View File

@@ -1,9 +1,6 @@
{
"policy_attach": {
"cooldown": "60",
"enabled": true,
"level": "30",
"policy_id": "lb001",
"priority": "60"
"policy_id": "lb001"
}
}

5
api-ref/src/wadls/clustering-api/src/v1/samples/cluster-policy-show-response.json
View File

@@ -2,13 +2,10 @@
"cluster_policy": {
"cluster_id": "7d85f602-a948-4a30-afd4-e84f47471c15",
"cluster_name": "cluster4",
"cooldown": 0,
"enabled": true,
"id": "06be3a1f-b238-4a96-a737-ceec5714087e",
"level": 0,
"policy_id": "714fe676-a08f-4196-b7af-61d52eeded15",
"policy_name": "dp01",
"policy_type": "DeletionPolicy",
"priority": 50
"policy_type": "senlin.policy.deletion-1.0"
}
}

5
api-ref/src/wadls/clustering-api/src/v1/samples/cluster-show-response.json
View File

@@ -1,8 +1,7 @@
{
"cluster": {
"created_time": "2015-02-11T15:13:20",
"created_at": "2015-02-11T15:13:20",
"data": {},
"deleted_time": null,
"desired_capacity": 0,
"domain": null,
"id": "45edadcb-c73b-4920-87e1-518b2f29f54b",
@@ -20,7 +19,7 @@
"status": "ACTIVE",
"status_reason": "Creation succeeded",
"timeout": 3600,
"updated_time": null,
"updated_at": null,
"user": "5e5bf8027826429c96af157f68dc9072"
}
}

5
api-ref/src/wadls/clustering-api/src/v1/samples/cluster-update-response.json
View File

@@ -1,8 +1,7 @@
{
"cluster": {
"created_time": "2015-02-11T15:13:20",
"created_at": "2015-02-11T15:13:20",
"data": {},
"deleted_time": null,
"desired_capacity": 0,
"domain": null,
"id": "45edadcb-c73b-4920-87e1-518b2f29f54b",
@@ -20,7 +19,7 @@
"status": "INIT",
"status_reason": "Initializing",
"timeout": 3600,
"updated_time": null,
"updated_at": null,
"user": "5e5bf8027826429c96af157f68dc9072"
}
}

5
api-ref/src/wadls/clustering-api/src/v1/samples/clusters-list-response.json
View File

@@ -1,9 +1,8 @@
{
"clusters": [
{
"created_time": "2015-02-10T14:26:14",
"created_at": "2015-02-10T14:26:14",
"data": {},
"deleted_time": null,
"desired_capacity": 4,
"domain": null,
"id": "7d85f602-a948-4a30-afd4-e84f47471c15",
@@ -25,7 +24,7 @@
"status": "ACTIVE",
"status_reason": "Cluster scale-in succeeded",
"timeout": 3600,
"updated_time": null,
"updated_at": null,
"user": "5e5bf8027826429c96af157f68dc9072"
}
]

3
api-ref/src/wadls/clustering-api/src/v1/samples/event-show-response.json
View File

@@ -2,7 +2,6 @@
"event": {
"action": "create",
"cluster_id": null,
"deleted_time": null,
"id": "2d255b9c-8f36-41a2-a137-c0175ccc29c3",
"level": "20",
"obj_id": "0df0931b-e251-4f2e-8719-4ebfda3627ba",
@@ -11,7 +10,7 @@
"project": "6e18cc2bdbeb48a5b3cad2dc499f6804",
"status": "CREATING",
"status_reason": "Initializing",
"timestamp": "2015-03-05T08:53:15.000000",
"timestamp": "2015-03-05T08:53:15",
"user": "a21ded6060534d99840658a777c2af5a"
}
}

3
api-ref/src/wadls/clustering-api/src/v1/samples/events-list-response.json
View File

@@ -3,7 +3,6 @@
{
"action": "create",
"cluster_id": null,
"deleted_time": null,
"id": "2d255b9c-8f36-41a2-a137-c0175ccc29c3",
"level": "20",
"obj_id": "0df0931b-e251-4f2e-8719-4ebfda3627ba",
@@ -12,7 +11,7 @@
"project": "6e18cc2bdbeb48a5b3cad2dc499f6804",
"status": "CREATING",
"status_reason": "Initializing",
"timestamp": "2015-03-05T08:53:15.000000",
"timestamp": "2015-03-05T08:53:15",
"user": "a21ded6060534d99840658a777c2af5a"
}
]

5
api-ref/src/wadls/clustering-api/src/v1/samples/node-create-response.json
View File

@@ -2,9 +2,8 @@
"node": {
"action": "2366d440-c73e-4961-9254-6d1c3af7c167",
"cluster_id": null,
"created_time": null,
"created_at": null,
"data": {},
"deleted_time": null,
"domain": null,
"id": "0df0931b-e251-4f2e-8719-4ebfda3627ba",
"index": -1,
@@ -18,7 +17,7 @@
"role": "master",
"status": "INIT",
"status_reason": "Initializing",
"updated_time": null,
"updated_at": null,
"user": "5e5bf8027826429c96af157f68dc9072"
}
}

5
api-ref/src/wadls/clustering-api/src/v1/samples/node-join-request.json
View File

@@ -1,5 +0,0 @@
{
"join": {
"cluster_id": "test_cluster"
}
}

3
api-ref/src/wadls/clustering-api/src/v1/samples/node-leave-request.json
View File

@@ -1,3 +0,0 @@
{
"leave": {}
}

5
api-ref/src/wadls/clustering-api/src/v1/samples/node-show-response.json
View File

@@ -1,9 +1,8 @@
{
"node": {
"cluster_id": null,
"created_time": "2015-02-10T12:03:16",
"created_at": "2015-02-10T12:03:16",
"data": {},
"deleted_time": null,
"domain": null,
"id": "d5779bb0-f0a0-49c9-88cc-6f078adb5a0b",
"index": -1,
@@ -17,7 +16,7 @@
"role": null,
"status": "ACTIVE",
"status_reason": "Creation succeeded",
"updated_time": "2015-03-04T04:58:27",
"updated_at": "2015-03-04T04:58:27",
"user": "5e5bf8027826429c96af157f68dc9072"
}
}

5
api-ref/src/wadls/clustering-api/src/v1/samples/node-update-response.json
View File

@@ -2,9 +2,8 @@
"node": {
"action": "2366d440-c73e-4961-9254-6d1c3af7c167",
"cluster_id": null,
"created_time": null,
"created_at": null,
"data": {},
"deleted_time": null,
"domain": null,
"id": "0df0931b-e251-4f2e-8719-4ebfda3627ba",
"index": -1,
@@ -18,7 +17,7 @@
"role": "master",
"status": "ACTIVE",
"status_reason": "Update succeeded",
"updated_time": "2015-09-01T18:53:15",
"updated_at": "2015-09-01T18:53:15",
"user": "5e5bf8027826429c96af157f68dc9072"
}
}

5
api-ref/src/wadls/clustering-api/src/v1/samples/nodes-list-response.json
View File

@@ -2,9 +2,8 @@
"nodes": [
{
"cluster_id": null,
"created_time": "2015-02-27T04:39:21",
"created_at": "2015-02-27T04:39:21",
"data": {},
"deleted_time": null,
"details": {},
"domain": null,
"id": "573aa1ba-bf45-49fd-907d-6b5d6e6adfd3",
@@ -19,7 +18,7 @@
"role": null,
"status": "ACTIVE",
"status_reason": "Creation succeeded",
"updated_time": null,
"updated_at": null,
"user": "5e5bf8027826429c96af157f68dc9072"
}
]

7
api-ref/src/wadls/clustering-api/src/v1/samples/policies-list-response.json
View File

@@ -1,13 +1,10 @@
{
"policies": [
{
"cooldown": 0,
"created_time": "2015-02-15T08:33:13.000000",
"created_at": "2015-02-15T08:33:13.000000",
"data": {},
"deleted_time": null,
"domain": null,
"id": "7192d8df-73be-4e98-ab99-1cf6d5066729",
"level": 0,
"name": "test_policy_1",
"project": "42d9e9663331431f97b75e25136307ff",
"spec": {
@@ -22,7 +19,7 @@
"version": "1.0"
},
"type": "senlin.policy.deletion-1.0",
"updated_time": null,
"updated_at": null,
"user": "5e5bf8027826429c96af157f68dc9072"
}
]

2
api-ref/src/wadls/clustering-api/src/v1/samples/policy-create-request.json
View File

@@ -1,7 +1,5 @@
{
"policy": {
"cooldown": 0,
"level": 0,
"name": "sp001",
"spec": {
"properties": {

7
api-ref/src/wadls/clustering-api/src/v1/samples/policy-create-response.json
View File

@@ -1,12 +1,9 @@
{
"policy": {
"cooldown": 0,
"created_time": "2015-03-02T07:40:31",
"created_at": "2015-03-02T07:40:31",
"data": {},
"deleted_time": null,
"domain": null,
"id": "02f62195-2198-4797-b0a9-877632208527",
"level": 0,
"name": "sp001",
"project": "42d9e9663331431f97b75e25136307ff",
"spec": {
@@ -23,7 +20,7 @@
"version": "1.0"
},
"type": "senlin.policy.scaling-1.0",
"updated_time": null,
"updated_at": null,
"user": "5e5bf8027826429c96af157f68dc9072"
}
}

7
api-ref/src/wadls/clustering-api/src/v1/samples/policy-show-response.json
View File

@@ -1,12 +1,9 @@
{
"policy": {
"cooldown": 0,
"created_time": "2015-03-02T07:40:31",
"created_at": "2015-03-02T07:40:31",
"data": {},
"deleted_time": null,
"domain": null,
"id": "02f62195-2198-4797-b0a9-877632208527",
"level": 0,
"name": "sp001",
"project": "42d9e9663331431f97b75e25136307ff",
"spec": {
@@ -23,7 +20,7 @@
"version": "1.0"
},
"type": "senlin.policy.scaling-1.0",
"updated_time": null,
"updated_at": null,
"user": "5e5bf8027826429c96af157f68dc9072"
}
}

2
api-ref/src/wadls/clustering-api/src/v1/samples/policy-update-request.json
View File

@@ -1,5 +1,5 @@
{
"policy": {
"cooldown": "34"
"name": "new_name"
}
}

7
api-ref/src/wadls/clustering-api/src/v1/samples/policy-update-response.json
View File

@@ -1,12 +1,9 @@
{
"policy": {
"cooldown": 0,
"created_time": "2015-10-14T09:14:53",
"created_at": "2015-10-14T09:14:53",
"data": {},
"deleted_time": null,
"domain": null,
"id": "ac5415bd-f522-4160-8be0-f8853e4bc332",
"level": 0,
"name": "dp01",
"project": "42d9e9663331431f97b75e25136307ff",
"spec": {
@@ -21,7 +18,7 @@
"version": "1.0"
},
"type": "senlin.policy.deletion-1.0",
"updated_time": null,
"updated_at": null,
"user": "5e5bf8027826429c96af157f68dc9072"
}
}

1
api-ref/src/wadls/clustering-api/src/v1/samples/profile-create-request.json
View File

@@ -2,7 +2,6 @@
"profile": {
"metadata": {},
"name": "test_prof1",
"permission": "xxx",
"spec": {
"properties": {
"disable_rollback": false,

6
api-ref/src/wadls/clustering-api/src/v1/samples/profile-create-response.json
View File

@@ -1,12 +1,10 @@
{
"profile": {
"created_time": "2015-03-01T14:28:25",
"deleted_time": null,
"created_at": "2015-03-01T14:28:25",
"domain": null,
"id": "7fa885cd-fa39-4531-a42d-780af95c84a4",
"metadata": {},
"name": "test_prof1",
"permission": "xxx",
"project": "42d9e9663331431f97b75e25136307ff",
"spec": {
"properties": {
@@ -55,7 +53,7 @@
"version": "1.0"
},
"type": "os.heat.stack-1.0",
"updated_time": null,
"updated_at": null,
"user": "5e5bf8027826429c96af157f68dc9072"
}
}

6
api-ref/src/wadls/clustering-api/src/v1/samples/profile-show-response.json
View File

@@ -1,12 +1,10 @@
{
"profile": {
"created_time": "2015-03-01T14:28:25",
"deleted_time": null,
"created_at": "2015-03-01T14:28:25",
"domain": null,
"id": "7fa885cd-fa39-4531-a42d-780af95c84a4",
"metadata": {},
"name": "test_prof1",
"permission": "xxx",
"project": "42d9e9663331431f97b75e25136307ff",
"spec": {
"disable_rollback": false,
@@ -53,7 +51,7 @@
"version": "1.0"
},
"type": "os.heat.stack-1.0",
"updated_time": null,
"updated_at": null,
"user": "5e5bf8027826429c96af157f68dc9072"
}
}

3
api-ref/src/wadls/clustering-api/src/v1/samples/profile-update-request.json
View File

@@ -1,7 +1,6 @@
{
"profile": {
"metadata": {},
"name": null,
"permission": "111100001111"
"name": null
}
}

6
api-ref/src/wadls/clustering-api/src/v1/samples/profile-update-response.json
View File

@@ -1,12 +1,10 @@
{
"profile": {
"created_time": "2015-03-01T14:28:25",
"deleted_time": null,
"created_at": "2015-03-01T14:28:25",
"domain": null,
"id": "7fa885cd-fa39-4531-a42d-780af95c84a4",
"metadata": {},
"name": "test_prof1",
"permission": "xxx",
"project": "42d9e9663331431f97b75e25136307ff",
"spec": {
"disable_rollback": false,
@@ -53,7 +51,7 @@
"version": "1.0"
},
"type": "os.heat.stack-1.0",
"updated_time": null,
"updated_at": null,
"user": "5e5bf8027826429c96af157f68dc9072"
}
}

6
api-ref/src/wadls/clustering-api/src/v1/samples/profiles-list-response.json
View File

@@ -1,13 +1,11 @@
{
"profiles": [
{
"created_time": "2015-02-10T11:46:33.000000",
"deleted_time": null,
"created_at": "2015-02-10T11:46:33.000000",
"domain": null,
"id": "edc63d0a-2ca4-48fa-9854-27926da76a4a",
"metadata": {},
"name": "mystack",
"permission": "",
"project": "42d9e9663331431f97b75e25136307ff",
"spec": {
"properties": {
@@ -58,7 +56,7 @@
"version": "1.0"
},
"type": "os.heat.stack-1.0",
"updated_time": null,
"updated_at": null,
"user": "5e5bf8027826429c96af157f68dc9072"
}
]

5
api-ref/src/wadls/clustering-api/src/v1/samples/receiver-create-response.json
View File

@@ -10,8 +10,7 @@
"alarm_url": "http://node1:8778/v1/webhooks/e03dd2e5-8f2e-4ec1-8c6a-74ba891e5422/trigger?V=1&count=1"
},
"cluster_id": "ae63a10b-4a90-452c-aef1-113a0b255ee3",
"created_time": "2015-06-27T05:09:43",
"deleted_time": null,
"created_at": "2015-06-27T05:09:43",
"domain": "Default",
"id": "573aa1ba-bf45-49fd-907d-6b5d6e6adfd3",
"name": "cluster_inflate",
@@ -20,7 +19,7 @@
},
"project": "6e18cc2bdbeb48a5b3cad2dc499f6804",
"type": "webhook",
"updated_time": null,
"updated_at": null,
"user": "b4ad2d6e18cc2b9c48049f6dbe8a5b3c"
}
}

5
api-ref/src/wadls/clustering-api/src/v1/samples/receiver-show-response.json
View File

@@ -10,8 +10,7 @@
"alarm_url": "http://node1:8778/v1/webhooks/e03dd2e5-8f2e-4ec1-8c6a-74ba891e5422/trigger?V=1&count=1"
},
"cluster_id": "ae63a10b-4a90-452c-aef1-113a0b255ee3",
"created_time": "2015-06-27T05:09:43",
"deleted_time": null,
"created_at": "2015-06-27T05:09:43",
"domain": "Default",
"id": "573aa1ba-bf45-49fd-907d-6b5d6e6adfd3",
"name": "cluster_inflate",
@@ -20,7 +19,7 @@
},
"project": "6e18cc2bdbeb48a5b3cad2dc499f6804",
"type": "webhook",
"updated_time": null,
"updated_at": null,
"user": "b4ad2d6e18cc2b9c48049f6dbe8a5b3c"
}
}

5
api-ref/src/wadls/clustering-api/src/v1/samples/receivers-list-response.json
View File

@@ -11,8 +11,7 @@
"alarm_url": "http://node1:8778/v1/webhooks/e03dd2e5-8f2e-4ec1-8c6a-74ba891e5422/trigger?V=1&count=1"
},
"cluster_id": "ae63a10b-4a90-452c-aef1-113a0b255ee3",
"created_time": "2015-06-27T05:09:43",
"deleted_time": null,
"created_at": "2015-06-27T05:09:43",
"domain": "Default",
"id": "573aa1ba-bf45-49fd-907d-6b5d6e6adfd3",
"name": "cluster_inflate",
@@ -21,7 +20,7 @@
},
"project": "6e18cc2bdbeb48a5b3cad2dc499f6804",
"type": "webhook",
"updated_time": null,
"updated_at": null,
"user": "b4ad2d6e18cc2b9c48049f6dbe8a5b3c"
}
]

539
api-ref/src/wadls/clustering-api/src/v1/wadl/clustering-api.wadl
View File

@@ -79,9 +79,6 @@
<method href="#showNode"/>
<method href="#updateNode"/>
<method href="#deleteNode"/>
<resource id="node_actions" path="actions">
<method href="#node_action"/>
</resource>
</resource>
</resource>
<resource id="actions" path="actions">
@@ -145,6 +142,8 @@
<request>
<representation mediaType="application/json">
&limitMarkerReqParameter;
&sortQueryParameter;
&global_projectRequestParameter;
<param name="name" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@@ -164,21 +163,6 @@
</para>
</wadl:doc>
</param>
<param name="show_deleted" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Includes deleted clusters in or excludes deleted
clusters from the cluster list.
</para>
<para>
Set to <code>False</code> to exclude deleted
clusters from the cluster list. Set to
<code>True</code> to include deleted clusters in
the cluster list. Default is <code>False</code>.
</para>
</wadl:doc>
</param>
<param name="show_nested" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@@ -194,49 +178,6 @@
</para>
</wadl:doc>
</param>
<param name="sort_key" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Sorts the list by an attribute. A valid value is
<code>name</code>, <code>status</code>,
<code>created_time</code>, or
<code>updated_time</code>.
</para>
</wadl:doc>
</param>
<param name="sort_dir" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Sort direction. A valid value is <code>asc</code>
(ascending) or <code>desc</code> (descending).
Default is <code>desc</code>. You can specify
multiple pairs of sort key and sort direction
query parameters. If you omit the sort direction
in a pair, the API uses the natural sorting
direction of the <code>sort_key</code> attribute
value.
</para>
</wadl:doc>
</param>
<param name="global_project" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Indicates whether to include nodes from either all
tenants or the current tenant.
</para>
<para>
If you are an administrative user and you set this
value to <code>True</code>, the call returns all
nodes from all tenants. Default is
<code>False</code>, which returns only nodes in
the current tenant.
</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
@@ -249,7 +190,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
List of cluster records. Each record contains
fields such as <code>created_time</code>,
fields such as <code>created_at</code>,
<code>id</code>, <code>name</code>,
<code>profile_id</code>, <code>size</code>,
<code>nodes</code>, <code>status</code>,
@@ -452,32 +393,7 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<param name="priority" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Filters the response by a policy priority on the cluster.
</para>
</wadl:doc>
</param>
<param name="level" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Filters the response by a policy enforcement level
on the cluster.
</para>
</wadl:doc>
</param>
<param name="cooldown" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Filters the response by a policy cool down value
on the cluster.
</para>
</wadl:doc>
</param>
&sortQueryParameter;
<param name="enabled" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@@ -487,31 +403,6 @@
</para>
</wadl:doc>
</param>
<param name="sort_key" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Sorts the list by an attribute. A valid attribute
is <code>priority</code>, <code>level</code>,
<code>cooldown</code>, or <code>enabled</code>.
</para>
</wadl:doc>
</param>
<param name="sort_dir" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Sort direction. A valid value is <code>asc</code>
(ascending) or <code>desc</code> (descending).
Default is <code>desc</code>. You can specify
multiple pairs of sort key and sort direction
query parameters. If you omit the sort direction
in a pair, the API uses the natural sorting
direction of the <code>sort_key</code> attribute.
</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
@@ -541,10 +432,9 @@
<para>
A <code>cluster_policy</code> map with keys such as
<code>cluster_id</code>, <code>policy_id</code>,
<code>policy_type </code>, <code>level</code>,
<code>cooldown</code>, <code>priority </code>, and so
on. The key values are attributes for the policy that
is attached to the cluster.
<code>policy_type </code>, and so on. The key values
are attributes for the policy that is attached to the
cluster.
</para>
<xsdxt:code href="../samples/cluster-policy-show-response.json"/>
</wadl:doc>
@@ -646,34 +536,8 @@
<request>
<representation mediaType="application/json">
&limitMarkerReqParameter;
<param name="sort_key" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Sorts the list by an attribute. A valid value is
<code>name</code>, <code>type</code>,
<code>created_time</code>,
<code>updated_time</code>,
<code>deleted_time</code>,
<code>permission</code>, or <code>metadata</code>.
</para>
</wadl:doc>
</param>
<param name="sort_dir" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Sort direction. A valid value is <code>asc</code>
(ascending) or <code>desc</code> (descending).
Default is <code>desc</code>. You can specify
multiple pairs of sort key and sort direction
query parameters. If you omit the sort direction
in a pair, the API uses the natural sorting
direction of the <code>sort_key</code> attribute.
</para>
</wadl:doc>
</param>
&sortQueryParameter;
&global_projectRequestParameter;
<param name="name" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@@ -690,14 +554,6 @@
</para>
</wadl:doc>
</param>
<param name="permission" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Filters the response by the permission string of a profile.
</para>
</wadl:doc>
</param>
<param name="metadata" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@@ -706,15 +562,6 @@
</para>
</wadl:doc>
</param>
<param name="show_deleted" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Includes deleted profiles in or excludes deleted
profiles from the response.
</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
@@ -729,8 +576,7 @@
Profile records. Each record contains the
<code>id</code>, <code>name</code>,
<code>type</code>, <code>spec</code>,
<code>permission</code>, <code>metadata</code>,
and other fields.
<code>metadata</code>, and other fields.
</para>
</wadl:doc>
</param>
@@ -787,12 +633,6 @@
based on the profile type.
</para>
</listitem>
<listitem>
<para>
<code>permission</code> The permission of
the profile.
</para>
</listitem>
<listitem>
<para>
<code>metadata</code> A list of key and
@@ -802,21 +642,15 @@
</listitem>
<listitem>
<para>
<code>created_time</code> The UTC date and
<code>created_at</code> The UTC date and
time stamp when the profile was created.
</para>
</listitem>
<listitem>
<para>
<code>updated_time</code> The UTC date and
<code>updated_at</code> The UTC date and
time stamp when the profile was updated.
</para>
</listitem>
<listitem>
<para>
<code>deleted_time</code> The UTC date and
time stamp when the profile was deleted.
</para>
</listitem>
<listitem>
<para>
@@ -851,8 +685,7 @@
<para>
A profile record. Contains fields such as
<code>id</code>, <code>name</code>, <code>type</code>,
<code>spec</code>, <code>permission</code>,
<code>metadata</code>, and so on.
<code>spec</code>, <code>metadata</code>, and so on.
</para>
<xsdxt:code href="../samples/profile-show-response.json"/>
</wadl:doc>
@@ -878,14 +711,6 @@
</para>
</wadl:doc>
</param>
<param name="permission" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
A permission.
</para>
</wadl:doc>
</param>
<param name="metadata" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@@ -903,8 +728,7 @@
<para>
A profile record. Contains fields such as
<code>id</code>, <code>name</code>, <code>type</code>,
<code>spec</code>, <code>permission</code>,
<code>metadata</code>, and so on.
<code>spec</code>, <code>metadata</code>, and so on.
</para>
<xsdxt:code href="../samples/profile-update-response.json"/>
</wadl:doc>
@@ -928,34 +752,8 @@
<request>
<representation mediaType="application/xml">
&limitMarkerReqParameter;
<param name="sort_key" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Sorts the list by an attribute. A valid value is
<code>name</code>, <code>type</code>,
<code>level</code>, <code>created_time</code>,
<code>updated_time</code>,
<code>deleted_time</code>, or
<code>cooldown</code> attribute.
</para>
</wadl:doc>
</param>
<param name="sort_dir" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Sort direction. A valid value is <code>asc</code>
(ascending) or <code>desc</code> (descending).
Default is <code>desc</code>. You can specify
multiple pairs of sort key and sort direction
query parameters. If you omit the sort direction
in a pair, the API uses the natural sorting
direction of the <code>sort_key</code> attribute.
</para>
</wadl:doc>
</param>
&sortQueryParameter;
&global_projectRequestParameter;
<param name="name" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@@ -972,32 +770,6 @@
</para>
</wadl:doc>
</param>
<param name="level" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Filters the response by the default enforcement
level of a policy.
</para>
</wadl:doc>
</param>
<param name="cooldown" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Filters the response by the default cooldown value
of a policy.
</para>
</wadl:doc>
</param>
<param name="show_deleted" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Specifies whether to list or omit deleted policies.
</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
@@ -1011,8 +783,7 @@
<para>
List of policy records. Each record contains
fields such as <code>id</code>, <code>name</code>,
<code>type</code>, <code>spec</code>,
<code>level</code>, <code>cooldown</code>, and so
<code>type</code>, <code>spec</code>, and so
on.
</para>
</wadl:doc>
@@ -1080,31 +851,15 @@
</listitem>
<listitem>
<para>
<code>level</code> A number representing the default enforcement level.
</para>
</listitem>
<listitem>
<para>
<code>cooldown</code> A number representing the default cooldown seconds.
</para>
</listitem>
<listitem>
<para>
<code>created_time</code> The UTC date and
<code>created_at</code> The UTC date and
time stamp when the policy was created.
</para>
</listitem>
<listitem>
<para>
<code>updated_time</code> The UTC date and
<code>updated_at</code> The UTC date and
time stamp when the policy was updated.
</para>
</listitem>
<listitem>
<para>
<code>deleted_time</code> The UTC date and
time stamp when the policy was deleted.
</para>
</listitem>
<listitem>
<para>
@@ -1139,9 +894,8 @@
<para>
A policy record with fields such as <code>id</code>,
<code>name</code>, <code>type</code>,
<code>spec</code>, <code>level</code>,
<code>cooldown</code>, <code>created_time</code>,
<code>deleted_time</code>, and so on.
<code>spec</code>, <code>created_at</code>,
<code>updated_at</code>, and so on.
</para>
<xsdxt:code href="../samples/policy-show-response.json"/>
</wadl:doc>
@@ -1173,17 +927,6 @@
<code>name</code> Name for the policy, if specified.
</para>
</listitem>
<listitem>
<para>
<code>level</code> Enforcement level for the policy, if specified.
</para>
</listitem>
<listitem>
<para>
<code>cooldown</code> The cooldown value for the policy, in
seconds, if specified.
</para>
</listitem>
</itemizedlist>
</wadl:doc>
</param>
@@ -1195,10 +938,8 @@
<para>
A policy record that includes fields such as
<code>id</code>, <code>name</code>, <code>type</code>,
<code>spec</code>, <code>level</code>,
<code>cooldown</code>, <code>created_time</code>,
<code>updated_time</code>, <code>deleted_time</code>,
and so on.
<code>spec</code>, <code>created_at</code>,
<code>updated_at</code>, and so on.
</para>
<xsdxt:code href="../samples/policy-update-response.json"/>
</wadl:doc>
@@ -1222,6 +963,8 @@
<request>
<representation mediaType="application/xml">
&limitMarkerReqParameter;
&sortQueryParameter;
&global_projectRequestParameter;
<param name="cluster_id" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@@ -1230,15 +973,6 @@
</para>
</wadl:doc>
</param>
<param name="show_deleted" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Includes deleted nodes in or excludes deleted
nodes from the list.
</para>
</wadl:doc>
</param>
<param name="name" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@@ -1255,41 +989,6 @@
</para>
</wadl:doc>
</param>
<param name="sort_key" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Sorts the list by an attribute. A valid attribute
is <code>name</code>, <code>status</code>,
<code>created_time</code>, or <code>updated_time
</code>.
</para>
</wadl:doc>
</param>
<param name="sort_dir" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Sort direction. A valid value is <code>asc</code>
(ascending) or <code>desc</code> (descending).
Default is <code>desc</code>. You can specify
multiple pairs of sort key and sort direction
query parameters. If you omit the sort direction
in a pair, the API uses the natural sorting
direction of the <code>sort_key</code> attribute.
</para>
</wadl:doc>
</param>
<param name="global_project" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Indicates whether to list or omit nodes from all tenants.
Operation subject to access policy enforcement.
</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
@@ -1305,9 +1004,9 @@
such as <code>id</code>, <code>cluster_id</code>,
<code>name</code>, <code>physical_id</code>,
<code>profile_id</code>,
<code>created_time</code>, <code>index</code>,
<code>created_at</code>, <code>index</code>,
<code>status</code>, <code>status_reason</code>,
<code>metadata</code>, <code>updated_time</code>,
<code>metadata</code>, <code>updated_at</code>,
and so on.
</para>
</wadl:doc>
@@ -1451,53 +1150,6 @@
</representation>
</response>
</method>
<method name="POST" id="node_action">
<wadl:doc xml:lang="EN" title="Trigger node action" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
Triggers an action on a node.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<param name="action" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
A map with the action to trigger. Optionally,
includes the parameters for the action. Supported
action names include:
</para>
<itemizedlist>
<listitem>
<para>
<code>join</code> Adds current node to a cluster.
<xsdxt:code href="../samples/node-join-request.json"/>
</para>
</listitem>
<listitem>
<para>
<code>leave</code> Deletes the current node from its cluster.
<xsdxt:code href="../samples/node-leave-request.json"/>
</para>
</listitem>
</itemizedlist>
</wadl:doc>
</param>
</representation>
</request>
<response status="202">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
A map that includes the <code>action</code> key and
value, where the value is the UUID of the action that
the request initiated.
</para>
</wadl:doc>
&actionLocationParameter;
</representation>
</response>
</method>
<method name="DELETE" id="deleteNode">
<wadl:doc xml:lang="EN" title="Delete node" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
@@ -1540,10 +1192,10 @@
A node record. Each record contains fields such as
<code>id</code>, <code>cluster_id</code>,
<code>name</code>, <code>physical_id</code>,
<code>profile_id</code>, <code>created_time</code>,
<code>profile_id</code>, <code>created_at</code>,
<code>index</code>, <code>status</code>,
<code>status_reason</code>, <code>metadata</code>,
<code>updated_time</code>, and so on.
<code>updated_at</code>, and so on.
</para>
<xsdxt:code href="../samples/node-show-response.json"/>
</wadl:doc>
@@ -1559,14 +1211,8 @@
<request>
<representation mediaType="application/xml">
&limitMarkerReqParameter;
<param name="show_deleted" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Indicates whether to show or omit deleted receivers.
</para>
</wadl:doc>
</param>
&sortQueryParameter;
&global_projectRequestParameter;
<param name="name" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@@ -1607,40 +1253,6 @@
</para>
</wadl:doc>
</param>
<param name="sort_key" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Sorts the list by an attribute. A valid attribute is
<code>name</code>, <code>type</code>, <code>action</code>,
<code>cluster_id</code> or <code>created_time</code>.
</para>
</wadl:doc>
</param>
<param name="sort_dir" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Sort direction. A valid value is <code>asc</code>
(ascending) or <code>desc</code> (descending).
Default is <code>desc</code>. You can specify
multiple pairs of sort key and sort direction
query parameters. If you omit the sort direction
in a pair, the API uses the natural sorting
direction of the <code>sort_key</code> attribute.
</para>
</wadl:doc>
</param>
<param name="global_project" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Indicates whether to show or omit receivers from all projects.
This operation is subject to access privilege checking.
</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
@@ -1653,8 +1265,8 @@
<code>domain</code>, <code>cluster_id</code>,
<code>type</code>, <code>action</code>,
<code>actor</code>, <code>params</code>,
<code>created_time</code> and
<code>deleted_time</code>, and so on.
<code>created_at</code> and
<code>updated_at</code>, and so on.
</para>
<xsdxt:code href="../samples/receivers-list-response.json"/>
</wadl:doc>
@@ -1759,8 +1371,7 @@
<code>cluster_id</code>, <code>action</code>,
<code>actor</code>, <code>params</code>,
<code>channel</code>,
<code>created_time</code>, <code>updated_time</code>,
<code>deleted_time</code>,
<code>created_at</code>, <code>updated_at</code>,
<code>user</code>, <code>project</code>,
<code>domain</code>, and so on.
</para>
@@ -1825,49 +1436,8 @@
<request>
<representation mediaType="application/json">
&limitMarkerReqParameter;
<param name="sort_key" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Sorts the list by an attribute. A valid attribute
is <code>timestamp</code>, <code>obj_type </code>,
<code>obj_name</code>, <code>user</code>, or
<code>action</code>.
</para>
</wadl:doc>
</param>
<param name="sort_dir" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Sort direction. A valid value is <code>asc</code>
(ascending) or <code>desc</code> (descending).
Default is <code>desc</code>. You can specify
multiple pairs of sort key and sort direction
query parameters. If you omit the sort direction
in a pair, the API uses the natural sorting
direction of the <code>sort_key</code> attribute.
</para>
</wadl:doc>
</param>
<param name="global_project" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Indicates whether to include or exclude events for all projects.
Default is <code>False</code>.
</para>
</wadl:doc>
</param>
<param name="show_deleted" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Indicates whether to include or exclude deleted events.
Default is <code>False</code>.
</para>
</wadl:doc>
</param>
&sortQueryParameter;
&global_projectRequestParameter;
<param name="obj_id" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@@ -1956,6 +1526,8 @@
<request>
<representation mediaType="application/json">
&limitMarkerReqParameter;
&sortQueryParameter;
&global_projectRequestParameter;
<param name="name" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@@ -1985,41 +1557,6 @@
</para>
</wadl:doc>
</param>
<param name="sort_key" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Sorts the list by the <code>name</code>,
<code>target</code>, <code>action</code>,
<code>created_time</code>, <code>status</code>, or
other attribute.
</para>
</wadl:doc>
</param>
<param name="sort_dir" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Sort direction. A valid value is <code>asc</code>
(ascending) or <code>desc</code> (descending).
Default is <code>desc</code>. You can specify
multiple pairs of sort key and sort direction
query parameters. If you omit the sort direction
in a pair, the API uses the natural sorting
direction of the <code>sort_key</code> attribute.
</para>
</wadl:doc>
</param>
<param name="show_deleted" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Indicates whether to include or exclude deleted
action entries. Default is <code>False</code>.
</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">

28
api-ref/src/wadls/common_project.ent
View File

@@ -134,6 +134,34 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY sortQueryParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort"
style="query" required="false" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Sorts the response by one or more attribute and optional sort
direction combinations. A valid direction is <code>asc</code>
(ascending) or <code>desc</code> (descending). Default direction
is <code>asc</code> (ascending).
</para>
<para>
Specify the list as &lt;key&gt;[:&lt;direction&gt;].
</para>
<para>
For example, the following query parameters in the URI sort the
objects in the response by <code>name</code> in ascending order
and then by <code>status</code> in descending order:
</para>
<programlisting language="json">GET /v2/images?sort=name:asc,status:desc</programlisting>
<para>
The following query parameters in the URI sort the objects in the
response by <code>name</code> in descending order and then by
<code>status</code> in ascending order.
</para>
<programlisting language="json">GET /v2/images?sort=name:desc,status</programlisting>
</wadl:doc>
</param>'>
<!ENTITY deleted_at-RequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="deleted_at" style="plain" required="false"
type="xsd:dateTime">

14
api-ref/src/wadls/image-api/src/v2/common.ent
View File

@@ -183,19 +183,7 @@
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort"
style="query" required="false" type="xsd:string" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Sorts by one or more attribute and sort direction combinations. You can
also set multiple sort keys and directions. Default direction is
<code>desc</code>.
</para>
<para>For example:</para>
<programlisting language="json">GET /v2/images?sort=name:asc,status:desc</programlisting>
</wadl:doc>
</param>
&sortQueryParameter;
<param xmlns="http://wadl.dev.java.net/2009/02" name="tag"
style="query" required="false" type="xsd:string" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook"

442
api-ref/src/wadls/volume-api/src/v2/common.ent
View File

@@ -206,22 +206,446 @@
</para>
</wadl:doc>
</param>'>
<!-- QUERY PARAMETERS -->
<!ENTITY sortQueryParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="sort" style="query" required="false" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<!ENTITY volume_type_idTemplateParameter '
<param name="volume_type_id" style="template"
required="true" type="csapi:UUID" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Comma-separated list of sort keys and optional sort directions in the
form of &lt;key&gt;[:&lt;direction&gt;]. A valid direction is
<code>asc</code> (ascending) or <code>desc</code> (descending).
The UUID for an existing volume type.
</para>
</wadl:doc>
</param>'>
<!ENTITY sort_keyQueryParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort_key"
style="query" required="false" type="xsd:string" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Sorts the response by an attribute. Default is <code>created_at</code>. The API uses
the natural sorting direction of the attribute that is provided as the
<code>sort_key</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY sort_dirQueryParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort_dir"
style="query" required="false" type="xsd:string" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Sorts the response by one or more sets of attribute and sort direction
combinations. If you omit the sort direction in a set, the default is
<code>desc</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY quotasShowRequest '
<param name="usage" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Set to <code>usage=True</code> to show quota usage. Default is
<code>False</code>.
</para></wadl:doc>
</param>'>
<!ENTITY quotaSetsReqParameters '
<param name="quota_set" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A <code>quota_set</code> object.</para></wadl:doc>
</param>
<param name="cores" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of instance cores allowed for
each tenant.</para></wadl:doc>
</param>
<param name="fixed_ips" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The number of fixed IP addresses allowed for each tenant. Must be
equal to or greater than the number of allowed instances.
</para></wadl:doc>
</param>
<param name="floating_ips" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The number of floating IP addresses allowed for each tenant.
</para></wadl:doc>
</param>
<param name="id" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The ID for the quota set.</para></wadl:doc>
</param>
<param name="injected_file_content_bytes"
style="plain" xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The number of bytes of content allowed for each injected file.
</para></wadl:doc>
</param>
<param name="injected_file_path_bytes" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of bytes allowed for each
injected file path.</para></wadl:doc>
</param>
<param name="injected_files" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of injected files allowed for
each tenant.</para></wadl:doc>
</param>
<param name="instances" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of instances allowed for each
tenant.</para></wadl:doc>
</param>
<param name="key_pairs" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of key pairs allowed for each
user.</para></wadl:doc>
</param>
<param name="metadata_items" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of metadata items allowed for
each instance.</para></wadl:doc>
</param>
<param name="ram" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The amount of instance RAM in megabytes
allowed for each tenant.</para></wadl:doc>
</param>
<param name="security_group_rules" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of rules allowed for each
security group.</para></wadl:doc>
</param>
<param name="security_groups" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of security groups allowed
for each tenant.</para></wadl:doc>
</param>'>
<!ENTITY quotasShowResponse '
<param name="in_use" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The in use data size. Visible only if you set the
<code>usage=True</code> query parameter.
</para>
</wadl:doc>
</param>
<param name="reserved" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Reserved volume size. Visible only if you set the
<code>usage=True</code> query parameter.
</para>
</wadl:doc>
</param>'>
<!ENTITY quotaSetsRespParameters '
<param name="quota_set" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A <code>quota_set</code> object.</para></wadl:doc>
</param>
<param name="cores" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of instance cores allowed for
each tenant.</para></wadl:doc>
</param>
<param name="fixed_ips" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The number of fixed IP addresses allowed for each tenant. Must be
equal to or greater than the number of allowed instances.
</para></wadl:doc>
</param>
<param name="floating_ips" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of floating IP addresses
allowed for each tenant.</para></wadl:doc>
</param>
<param name="id" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The ID for the quota set.</para></wadl:doc>
</param>
<param name="injected_file_content_bytes"
style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of bytes of content allowed
for each injected file.</para></wadl:doc>
</param>
<param name="injected_file_path_bytes" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of bytes allowed for each
injected file path.</para></wadl:doc>
</param>
<param name="injected_files" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of injected files allowed for
each tenant.</para></wadl:doc>
</param>
<param name="instances" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of instances allowed for each
tenant.</para></wadl:doc>
</param>
<param name="key_pairs" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of key pairs allowed for each
user.</para></wadl:doc>
</param>
<param name="metadata_items" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The number of metadata items allowed for each instance.
</para></wadl:doc>
</param>
<param name="ram" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The amount of instance RAM in megabytes
allowed for each tenant.</para></wadl:doc>
</param>
<param name="security_group_rules" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of rules allowed for each
security group.</para></wadl:doc>
</param>
<param name="security_groups" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The number of security groups allowed for each tenant.
</para></wadl:doc>
</param>'>
<!ENTITY limitsRespParameters '
<param name="limits" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A <code>limits</code> object.</para></wadl:doc>
</param>
<param name="absolute" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>An <code>absolute</code> limits object.</para></wadl:doc>
</param>
<param name="totalSnapshotsUsed" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Total number of snapshots used.</para></wadl:doc>
</param>
<param name="maxTotalBackups" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Maximum number of backups.</para></wadl:doc>
</param>
<param name="maxTotalVolumeGigabytes" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Maximum total amount of volumes, in gibibytes (GiB).</para></wadl:doc>
</param>
<param name="maxTotalSnapshots" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Maximum number of snapshots.</para></wadl:doc>
</param>
<param name="maxTotalBackupGigabytes" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Maximum total amount of backups, in gibibytes (GiB).</para></wadl:doc>
</param>
<param name="totalBackupGigabytesUsed" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Total number of backups gibibytes (GiB) used.</para></wadl:doc>
</param>
<param name="maxTotalVolumes" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Maximum number of volumes.</para></wadl:doc>
</param>
<param name="totalVolumesUsed" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Total number of volumes used.</para></wadl:doc>
</param>
<param name="totalBackupsUsed" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Total number of backups used.</para></wadl:doc>
</param>
<param name="totalGigabytesUsed" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Total number of gibibytes (GiB) used.</para></wadl:doc>
</param>'>
<!ENTITY createVolumeParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="availability_zone" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The availability zone.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="source_volid" style="plain"
type="csapi:UUID" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>