openstack/vitrage
Code Issues Proposed changes

Merge "Repair the topology interface in api doc"

Browse Source
This commit is contained in:
Zuul 2020-04-13 15:42:26 +00:00 committed by Gerrit Code Review
commit 565380c647
1 changed files with 114 additions and 145 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

259
doc/source/contributor/vitrage-api.rst
View File

@ -215,152 +215,121 @@ Response Examples
:: ::
{ {
"directed": true, "vitrage_id": "96f6a30a-51eb-4e71-ae4a-0703b21ffa98",
"graph": {}, "name": "openstack.cluster",
"nodes": [ "graph_index": 0,
{ "vitrage_category": "RESOURCE",
"vitrage_id": "96f6a30a-51eb-4e71-ae4a-0703b21ffa98", "vitrage_operational_state": "OK",
"name": "openstack.cluster", "state": "available",
"graph_index": 0, "vitrage_type": "openstack.cluster",
"vitrage_category": "RESOURCE", "vitrage_sample_timestamp": "2018-06-11 08:43:33.757864+00:00",
"vitrage_operational_state": "OK", "vitrage_aggregated_state": "AVAILABLE",
"state": "available", "vitrage_is_placeholder": false,
"vitrage_type": "openstack.cluster", "id": "OpenStack Cluster",
"vitrage_sample_timestamp": "2018-06-11 08:43:33.757864+00:00", "is_real_vitrage_id": true,
"vitrage_aggregated_state": "AVAILABLE", "vitrage_is_deleted": false,
"vitrage_is_placeholder": false, "children": [
"id": "OpenStack Cluster", {
"is_real_vitrage_id": true, "vitrage_id": "12b11320-a6de-4ce5-892f-78fb1fa6bfef",
"vitrage_is_deleted": false "name": "nova",
}, "update_timestamp": "2018-06-11 08:43:33.757864+00:00",
{ "vitrage_category": "RESOURCE",
"vitrage_id": "12b11320-a6de-4ce5-892f-78fb1fa6bfef", "vitrage_operational_state": "OK",
"name": "nova", "state": "available",
"update_timestamp": "2018-06-11 08:43:33.757864+00:00", "vitrage_type": "nova.zone",
"vitrage_category": "RESOURCE", "vitrage_sample_timestamp": "2018-06-11 08:43:33.757864+00:00",
"vitrage_operational_state": "OK", "graph_index": 1,
"state": "available", "vitrage_aggregated_state": "AVAILABLE",
"vitrage_type": "nova.zone", "vitrage_is_placeholder": false,
"vitrage_sample_timestamp": "2018-06-11 08:43:33.757864+00:00", "id": "nova",
"graph_index": 1, "is_real_vitrage_id": true,
"vitrage_aggregated_state": "AVAILABLE", "vitrage_is_deleted": false,
"vitrage_is_placeholder": false, "children": [
"id": "nova", {
"is_real_vitrage_id": true, "vitrage_id": "5f9893b8-c622-4cb8-912d-534980f4e4f9",
"vitrage_is_deleted": false "name": "devstack-rocky-8",
}, "update_timestamp": "2018-06-11 08:43:33.518059+00:00",
{ "vitrage_category": "RESOURCE",
"vitrage_id": "c90cc1dd-409c-4354-92f8-79b993e584c0", "vitrage_operational_state": "OK",
"vitrage_is_deleted": false, "state": "available",
"graph_index": 2, "vitrage_type": "nova.host",
"vitrage_category": "RESOURCE", "vitrage_sample_timestamp": "2018-06-11 08:43:33.757864+00:00",
"vitrage_operational_state": "N/A", "graph_index": 2,
"vitrage_type": "nova.instance", "vitrage_aggregated_state": "AVAILABLE",
"vitrage_sample_timestamp": "2018-06-11 08:33:33.457974+00:00", "vitrage_is_placeholder": false,
"vitrage_aggregated_state": null, "id": "devstack-rocky-8",
"vitrage_is_placeholder": true, "is_real_vitrage_id": true,
"id": "ce173654-c70d-4514-a3e9-1f9dd5c09dd8", "vitrage_is_deleted": false,
"is_real_vitrage_id": true "children": [
}, {
{ "vitrage_id": "c90cc1dd-409c-4354-92f8-79b993e584c0",
"vitrage_id": "94060508-5fea-4927-9a53-2b66864ab883", "vitrage_is_deleted": false,
"vitrage_is_deleted": false, "graph_index": 3,
"graph_index": 3, "vitrage_category": "RESOURCE",
"vitrage_category": "RESOURCE", "vitrage_operational_state": "N/A",
"vitrage_operational_state": "N/A", "vitrage_type": "nova.instance",
"vitrage_type": "nova.instance", "vitrage_sample_timestamp": "2018-06-11 08:33:33.457974+00:00",
"vitrage_sample_timestamp": "2018-06-11 08:33:33.457992+00:00", "vitrage_aggregated_state": null,
"vitrage_aggregated_state": null, "vitrage_is_placeholder": true,
"vitrage_is_placeholder": true, "id": "ce173654-c70d-4514-a3e9-1f9dd5c09dd8",
"id": "3af9a215-e109-476a-aa55-6868990684e4", "is_real_vitrage_id": true
"is_real_vitrage_id": true },
}, {
{ "vitrage_id": "94060508-5fea-4927-9a53-2b66864ab883",
"vitrage_id": "ae0886d8-ee90-41df-a80a-006fdb80105b", "vitrage_is_deleted": false,
"graph_index": 4, "graph_index": 4,
"name": "vm-4", "vitrage_category": "RESOURCE",
"update_timestamp": "2018-06-11 08:43:34.421455+00:00", "vitrage_operational_state": "N/A",
"vitrage_category": "RESOURCE", "vitrage_type": "nova.instance",
"vitrage_operational_state": "OK", "vitrage_sample_timestamp": "2018-06-11 08:33:33.457992+00:00",
"state": "ACTIVE", "vitrage_aggregated_state": null,
"vitrage_type": "nova.instance", "vitrage_is_placeholder": true,
"vitrage_sample_timestamp": "2018-06-11 08:43:34.421455+00:00", "id": "3af9a215-e109-476a-aa55-6868990684e4",
"host_id": "devstack-rocky-8", "is_real_vitrage_id": true
"vitrage_aggregated_state": "ACTIVE", },
"vitrage_is_placeholder": false, {
"project_id": "aa792cde038b41858a0f1bcf8f9b092d", "vitrage_id": "ae0886d8-ee90-41df-a80a-006fdb80105b",
"id": "1233e48c-62ee-470e-8d4a-adff30211b5d", "graph_index": 5,
"is_real_vitrage_id": true, "name": "vm-4",
"vitrage_is_deleted": false "update_timestamp": "2018-06-11 08:43:34.421455+00:00",
}, "vitrage_category": "RESOURCE",
{ "vitrage_operational_state": "OK",
"vitrage_id": "4d197913-0687-4300-afb7-7fd331d35cff", "state": "ACTIVE",
"graph_index": 5, "vitrage_type": "nova.instance",
"name": "vm-3", "vitrage_sample_timestamp": "2018-06-11 08:43:34.421455+00:00",
"update_timestamp": "2018-06-11 08:43:34.421490+00:00", "host_id": "devstack-rocky-8",
"vitrage_category": "RESOURCE", "vitrage_aggregated_state": "ACTIVE",
"vitrage_operational_state": "OK", "vitrage_is_placeholder": false,
"state": "ACTIVE", "project_id": "aa792cde038b41858a0f1bcf8f9b092d",
"vitrage_type": "nova.instance", "id": "1233e48c-62ee-470e-8d4a-adff30211b5d",
"vitrage_sample_timestamp": "2018-06-11 08:47:24.137324+00:00", "is_real_vitrage_id": true,
"host_id": "devstack-rocky-8", "vitrage_is_deleted": false
"vitrage_aggregated_state": "ACTIVE", },
"vitrage_is_placeholder": false, {
"project_id": "aa792cde038b41858a0f1bcf8f9b092d", "vitrage_id": "4d197913-0687-4300-afb7-7fd331d35cff",
"id": "12cc6d3e-f801-4422-b2a0-43cedacb4eb5", "graph_index": 6,
"is_real_vitrage_id": true, "name": "vm-3",
"vitrage_is_deleted": false "update_timestamp": "2018-06-11 08:43:34.421490+00:00",
}, "vitrage_category": "RESOURCE",
{ "vitrage_operational_state": "OK",
"vitrage_id": "5f9893b8-c622-4cb8-912d-534980f4e4f9", "state": "ACTIVE",
"name": "devstack-rocky-8", "vitrage_type": "nova.instance",
"update_timestamp": "2018-06-11 08:43:33.518059+00:00", "vitrage_sample_timestamp": "2018-06-11 08:47:24.137324+00:00",
"vitrage_category": "RESOURCE", "host_id": "devstack-rocky-8",
"vitrage_operational_state": "OK", "vitrage_aggregated_state": "ACTIVE",
"state": "available", "vitrage_is_placeholder": false,
"vitrage_type": "nova.host", "project_id": "aa792cde038b41858a0f1bcf8f9b092d",
"vitrage_sample_timestamp": "2018-06-11 08:43:33.757864+00:00", "id": "12cc6d3e-f801-4422-b2a0-43cedacb4eb5",
"graph_index": 6, "is_real_vitrage_id": true,
"vitrage_aggregated_state": "AVAILABLE", "vitrage_is_deleted": false
"vitrage_is_placeholder": false, }
"id": "devstack-rocky-8", ]
"is_real_vitrage_id": true, }
"vitrage_is_deleted": false ]
}
]
} }
],
"links": [
{
"relationship_type": "contains",
"source": 0,
"vitrage_is_deleted": false,
"key": "contains",
"target": 1
},
{
"relationship_type": "contains",
"source": 1,
"vitrage_is_deleted": false,
"key": "contains",
"target": 6
},
{
"relationship_type": "contains",
"source": 6,
"vitrage_is_deleted": false,
"key": "contains",
"target": 4
},
{
"relationship_type": "contains",
"source": 6,
"vitrage_is_deleted": false,
"key": "contains",
"target": 5
}
],
"multigraph": true
}
Show RCA Show RCA
^^^^^^^^ ^^^^^^^^