summaryrefslogtreecommitdiff
path: root/api-ref/source
diff options
context:
space:
mode:
authorLingxian Kong <anlin.kong@gmail.com>2020-12-02 14:36:39 +1300
committerLingxian Kong <anlin.kong@gmail.com>2020-12-09 14:17:16 +1300
commitca04c94ef66ed16169e949e680fb3b31025cb61a (patch)
tree43d04462568204c242e8989ba1bbdd054d55e886 /api-ref/source
parent9ea87ccf4334e893565c2fa1ee8e587f56e592a1 (diff)
downloadtrove-ca04c94ef66ed16169e949e680fb3b31025cb61a.tar.gz
Support instance operating_status
Added a new field ``operating_status`` for the instance to show the actual operational status of user's database. Change-Id: I7c52cff0ec48289fe1a260e99e02a506d4f8ddec
Diffstat (limited to 'api-ref/source')
-rw-r--r--api-ref/source/instances.inc2
-rwxr-xr-xapi-ref/source/parameters.yaml6
-rw-r--r--api-ref/source/samples/instance-create-response.json33
-rw-r--r--api-ref/source/samples/instance-list-detail-response.json4
-rw-r--r--api-ref/source/samples/instance-list-response.json1
-rw-r--r--api-ref/source/samples/instance-mgmt-list-response.json4
-rw-r--r--api-ref/source/samples/instance-mgmt-show-response.json3
-rw-r--r--api-ref/source/samples/instance-show-response.json3
8 files changed, 43 insertions, 13 deletions
diff --git a/api-ref/source/instances.inc b/api-ref/source/instances.inc
index 0cc834ec..db8b872e 100644
--- a/api-ref/source/instances.inc
+++ b/api-ref/source/instances.inc
@@ -160,6 +160,7 @@ Response Parameters
- id: instanceId1
- name: instanceName1
- status: instance_status
+ - operating_status: operating_status
- links: instance_links
- links.href: instance_link_href
- links.rel: instance_link_rel
@@ -226,6 +227,7 @@ Response Parameters
- id: instanceId1
- name: instanceName1
- status: instance_status
+ - operating_status: operating_status
- links: instance_links
- links.href: instance_link_href
- links.rel: instance_link_rel
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 20a0123b..6918f2e4 100755
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -717,6 +717,12 @@ nics:
in: body
required: false
type: array
+operating_status:
+ description: |
+ The operating status of the database service inside the Trove instance.
+ in: body
+ required: true
+ type: string
project_uuid:
description: |
The project ID of the resource.
diff --git a/api-ref/source/samples/instance-create-response.json b/api-ref/source/samples/instance-create-response.json
index 14edc0aa..1fd74ac1 100644
--- a/api-ref/source/samples/instance-create-response.json
+++ b/api-ref/source/samples/instance-create-response.json
@@ -1,14 +1,27 @@
{
"instance": {
- "created": "2019-12-23T20:53:38",
+ "id": "b76a6a76-748b-4064-adec-4c9e6c9abd68",
+ "name": "test",
+ "status": "BUILD",
+ "operating_status": "",
"datastore": {
"type": "mysql",
- "version": "5.7"
+ "version": "5.7.29",
+ "version_number": "5.7.29"
},
"flavor": {
- "id": "6"
+ "id": "3ca76fe7-8dc1-4059-b728-de725835abcb",
+ "links": [
+ {
+ "href": "https://192.168.206.8:87 79/v1.0/c37341d7d1934ebc949c9d6b5c9f818c/flavors/3ca76fe7-8dc1-4059-b728-de725835abcb",
+ "rel": "self"
+ },
+ {
+ "href": "https://192.168.206.8:8779/flavors/3ca76fe7-8dc1-4059-b728-de725835abcb",
+ "rel": "bookmark"
+ }
+ ]
},
- "id": "b76a6a76-748b-4064-adec-4c9e6c9abd68",
"links": [
{
"href": "https://127.0.0.1:8779/v1.0/9f8dd5eacb074c9f87d2d822c9092aa5/instances/b76a6a76-748b-4064-adec-4c9e6c9abd68",
@@ -19,13 +32,15 @@
"rel": "bookmark"
}
],
- "name": "test",
"region": "RegionOne",
- "service_status_updated": "2019-12-23T20:53:38",
- "status": "BUILD",
- "updated": "2019-12-23T20:53:38",
+ "access": {
+ "is_public": false
+ },
"volume": {
"size": 1
- }
+ },
+ "created": "2019-12-23T20:53:38",
+ "updated": "2019-12-23T20:53:38",
+ "service_status_updated": "2019-12-23T20:53:38"
}
} \ No newline at end of file
diff --git a/api-ref/source/samples/instance-list-detail-response.json b/api-ref/source/samples/instance-list-detail-response.json
index f253c099..b938de88 100644
--- a/api-ref/source/samples/instance-list-detail-response.json
+++ b/api-ref/source/samples/instance-list-detail-response.json
@@ -35,9 +35,10 @@
}
],
"name": "test",
+ "operating_status": "HEALTHY",
"region": "RegionOne",
"service_status_updated": "2019-12-23T21:01:11",
- "status": "HEALTHY",
+ "status": "ACTIVE",
"updated": "2019-12-23T20:58:45",
"volume": {
"size": 1
@@ -69,6 +70,7 @@
}
],
"name": "test",
+ "operating_status": "",
"region": "RegionOne",
"service_status_updated": "2019-12-23T20:53:38",
"status": "ERROR",
diff --git a/api-ref/source/samples/instance-list-response.json b/api-ref/source/samples/instance-list-response.json
index df995aa1..32d3200f 100644
--- a/api-ref/source/samples/instance-list-response.json
+++ b/api-ref/source/samples/instance-list-response.json
@@ -24,6 +24,7 @@
}
],
"name": "test",
+ "operating_status": "HEALTHY",
"region": "RegionOne",
"status": "ACTIVE",
"volume": {
diff --git a/api-ref/source/samples/instance-mgmt-list-response.json b/api-ref/source/samples/instance-mgmt-list-response.json
index 17ec62c2..071e610c 100644
--- a/api-ref/source/samples/instance-mgmt-list-response.json
+++ b/api-ref/source/samples/instance-mgmt-list-response.json
@@ -37,6 +37,7 @@
}
],
"name": "test",
+ "operating_status": "HEALTHY",
"region": "RegionOne",
"server": {
"host": "bdfe3275004d2a98d38d494fd7adfcd0c6d5d5198e86fa0d6ec5d588",
@@ -48,7 +49,7 @@
"server_id": "710a84e5-6adf-4a4c-9167-8bade67a5a1c",
"service_status": "HEALTHY",
"service_status_updated": "2019-12-24T00:02:55",
- "status": "HEALTHY",
+ "status": "ACTIVE",
"task_description": "No tasks for the instance.",
"tenant_id": "9f8dd5eacb074c9f87d2d822c9092aa5",
"updated": "2019-12-23T23:53:46",
@@ -86,6 +87,7 @@
}
],
"name": "test",
+ "operating_status": "",
"region": "RegionOne",
"server": null,
"server_id": null,
diff --git a/api-ref/source/samples/instance-mgmt-show-response.json b/api-ref/source/samples/instance-mgmt-show-response.json
index 9ca5bd9c..23ce592c 100644
--- a/api-ref/source/samples/instance-mgmt-show-response.json
+++ b/api-ref/source/samples/instance-mgmt-show-response.json
@@ -40,6 +40,7 @@
}
],
"name": "test",
+ "operating_status": "HEALTHY",
"region": "RegionOne",
"server": {
"addresses": {
@@ -75,7 +76,7 @@
"server_id": "710a84e5-6adf-4a4c-9167-8bade67a5a1c",
"service_status": "HEALTHY",
"service_status_updated": "2019-12-24T00:08:55",
- "status": "HEALTHY",
+ "status": "ACTIVE",
"task_description": "No tasks for the instance.",
"tenant_id": "9f8dd5eacb074c9f87d2d822c9092aa5",
"updated": "2019-12-23T23:53:46",
diff --git a/api-ref/source/samples/instance-show-response.json b/api-ref/source/samples/instance-show-response.json
index 7b609682..49579242 100644
--- a/api-ref/source/samples/instance-show-response.json
+++ b/api-ref/source/samples/instance-show-response.json
@@ -34,9 +34,10 @@
}
],
"name": "test",
+ "operating_status": "HEALTHY",
"region": "RegionOne",
"service_status_updated": "2019-12-23T22:15:11",
- "status": "HEALTHY",
+ "status": "ACTIVE",
"updated": "2019-12-23T20:58:45",
"volume": {
"size": 1,